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.
On Nov 30, 2007 12:26 AM, <bphuettner -at- aol -dot- com> wrote:
I'd say Unix man pages set a minimum standard. That was
back about 1970, but it is amazing how many more recent
systems get it wrong..
Everything available online and printable. Complete docs,
including things like documenting all file formats used.
Extensive cross-referencing. Both reference material
with all the details and tutorials with a user viewpoint.
Granted, nroff is obsolete and we can do it much better
today, but I'd still say that's a minimum standard that
needs to be met in any software documentation.
--
Sandy Harris,
Nanjing, China
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Create HTML or Microsoft Word content and convert to Help file formats or
printed documentation. Features include support for Windows Vista & 2007
Microsoft Office, team authoring, plus more. http://www.DocToHelp.com/TechwrlList
True single source, conditional content, PDF export, modular help.
Help & Manual is the most powerful authoring tool for technical
documentation. Boost your productivity! http://www.helpandmanual.com
---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-
