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: TECHWR-L Digest - 23 Mar 1999 to 24 Mar 1999 From:John Wilson <jwilson -at- AMADEUS -dot- NET> Date:Thu, 25 Mar 1999 09:38:30 +0100
Chris Despopoulos wrote:
In fact, it is a very good idea to have
templates that include sections for every category that
needs coverage. And those sections should be in place, with
titles for each category, and the body of each section
should define the category. Then a developer merely needs
to go through the template and replace the existing text
with his own meaningful prose.
I have often used this approach and engineers like it although they may
nitpick, as it saves them a lot of decisions about structuring the spec.
Has anyone got any templates for specs or allied documents that they could
post? (I didn't keep the ones I used).
Regards
John
