TechWhirl (TECHWR-L) is a resource for technical writing and technical communications professionals of all experience levels and in all industries to share their experiences and acquire information.
For two decades, technical communicators have turned to TechWhirl to ask and answer questions about the always-changing world of technical communications, such as tools, skills, career paths, methodologies, and emerging industries. The TechWhirl Archives and magazine, created for, by and about technical writers, offer a wealth of knowledge to everyone with an interest in any aspect of technical communications.
Subject:Re: Organization of documentation From:etienneg -at- interlog -dot- com To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Mon, 11 Mar 2002 16:10:27 US/Eastern
The size and number of books was just given to give a context.
I am considering reorganizing it because I do not think it
work as well as it should.
It consist of a mix of user's guides (different type of
users), reference guides, with task oriented stufff, system
oriented stuff, context elements, etc. In my opinion, it is
not organized in a logical or practical way.
I am reseaching the best basis for reorganizing it and to
sell that reorganization to my boss.
> -- etienneg -at- interlog -dot- com wrote:
> > The documentation of our software presently consists of
> > about 3000 pages in 9 different books.
> >
> > I am considering reorganizing it.
> >
> > I am looking for papers, articles, or books covering
> > different ways of organizing documentation of such size.
>
> Reorganization has less to do with size and more to do
with finding a
> better way to find stuff.
>
> What kind of stuff is this?
>
> I have over 50 phone books by my desk, with WELL over 3,000
> pages...maybe closer to 300,000 pages. Alphbetical by
city, then
> last name works the best.
>
> =====
> John Posada, Senior Technical Writer
> Current gig ending 4/15
> Resume: http://www.tdandw.com/Resume_Posada_022202.doc
>mailto:john -at- tdandw -dot- com, 732-259-2874
>
> __________________________________________________
> Do You Yahoo!?
> Try FREE Yahoo! Mail - the world's greatest free email!
>http://mail.yahoo.com/
>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Check it out! Get some cool freebies when you buy RoboHelp! You'll receive
SnagIt screen capture software and a 10% discount voucher for RoboHelp
Consulting. This special offers expires March 29, 2002.
www.ehelp.com/techwr
---
You are currently subscribed to techwr-l as: archive -at- raycomm -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- raycomm -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot- Visit http://www.raycomm.com/techwhirl/ for more resources and info.