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: Code-based Manual From:Daniel P Read <danielread -at- JUNO -dot- COM> Date:Mon, 2 Dec 1996 11:41:19 EST
>>Keith Posner wrote about planning a manual for a code-based system
>>(rather than GUI).
>>Focus is important. You can demonstrate types of real-world tasks with
>>some examples, but you cannot cover each possible request. Categorizing
>>requests into types will probably organize the information about
syntax
>>that you'd like to convey.
>>Obvious, I know -- but true. It is too easy to assume you can cover
all
>>scenarios in one manual.
I would add to this that you want to make sure you combine the
tutorial/examples approach with another section that contains a
command/function reference, with a standard template for organizing the
reference for each command/function. The template should include
classifications for the commands, syntax, examples (be prolific with code
examples), details on each component of the syntax, notes and caveats,
and cross reference to other related commands.
