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: Eliminating Need for Technical Support From:Sunil Gokhale <sunilg -at- PUNE -dot- TCS -dot- CO -dot- IN> Date:Thu, 3 Jul 1997 10:04:16 +0530
From the discussion of Stuart Burnfield and Stephen Blount, I wondered
whether we could define what `good' documentation was - The word `Good'
has so many shades - that will be possible to define GOOD DOCUMENTATION.
Apart from being clear and simple, easy to understand are there certain
specific topics where the `goodness' could be seen and metered. Let me
list a few -
1. It should be well structured, so that browsing is easier - the internal
and external structure should be streamlined.
2. Matter should be specific, to-the-point.
3. It should be able to cross language barriers.
Anyone who wishes to add ?
Sunil Gokhale, Technical Communicator
Tata Consultancy Services
sunilg -at- pune -dot- tcs -dot- co -dot- in
TECHWR-L (Technical Communication) List Information: To send a message
to 2500+ readers, e-mail to TECHWR-L -at- LISTSERV -dot- OKSTATE -dot- EDU -dot- Send commands
to LISTSERV -at- LISTSERV -dot- OKSTATE -dot- EDU (e.g. HELP or SIGNOFF TECHWR-L).
Search the archives at http://www.documentation.com/ or search and
browse the archives at http://listserv.okstate.edu/archives/techwr-l.html
