Re: Technical Standards Manual
I have been asked to compile a Technical Standards Manual. Can anyone
please tell me what it should include? From past experience I think I
should have rules for writing, and templates for standard system development
life cycle documents. I would also appreciate you telling me where I can
find a list of recommended documents and templates, and sample templates for
the most commonly used documents.
Any help would be greatly appreciated.
In a software development environment this would also include a section on coding standards (rules for Hungarian notation, if that is being used, or other naming conventions; rules for standard comment blocks; other policies aimed at maintainability and extendability of the code); in an electrical or mechanical engineering environment it would include a section on drafting conventions, perhaps (although I suppose these are pretty global and might not be needed) or data exchange protocols (what file formats are acceptable for drawings, what the dimensions of the standard sheet sizes are, etc.).
There might also be sections on document retention rules, document security/accessibility rules, document naming and numbering conventions, document management procedures (reviews, signoffs, versioning, ownership, organization of folders in the system, handling of physical documents, etc.).
This is not meant to be exhaustive, just some additional ideas for you to mull over.
SEE THE ALL NEW ROBOHELP X5 IN ACTION: RoboHelp X5 is a giant leap forward
in Help authoring technology, featuring Word 2003 support, Content Management, Multi-Author support, PDF and XML support and much more! http://www.macromedia.com/go/techwrldemo
COMPONENTONE DOC-TO-HELP 7 PROFESSIONAL: From a single set of Word documents, create online Help and printed documentation. New version offers yearly subscription service, Natural Search, Modular TOC Utility, Image Map Editor, Theme Designer, Context String Editor, plus more. http://www.componentone.com/doctohelp .
You are currently subscribed to techwr-l as:
archiver -at- techwr-l -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- raycomm -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot- Visit
http://www.raycomm.com/techwhirl/ for more resources and info.
Technical Standards Manual: From: Robertson, Susan
Previous by Author:
Re: Web animation technology question
Next by Author: Common courtesy from your neighbors!?!?
Previous by Thread: Technical Standards Manual
Next by Thread: Re: Technical Standards Manual
Search our Technical Writing Archives & Magazine