TechWhirl Sponsors

About TechWhirl

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.

re: Spec organization

----------------------------------
Haas, Guy asked:
Do any of you have any architectural suggestions -- things that worked for you? or perhaps horror stories about things that did not work well?
----------------------------------

Organize the files by release. Have the developers put all the materials for a single release in a single folder.

As for the format of the spec, it would probably be convenient for them to put the name of the person making the change, the name of the affected functions (if possible), and maybe estimated time to completion. You could also have them number the changes so that you can track them easier (that's if you're storing your docs in a database).

Check out the new release of RoboDemo, our easy-to-use tutorial software.
Plus, buy RoboHelp Office in August and save $100 with our mail-in rebate.
Get details and download free trial versions at http://www.ehelp.com/techwr-l