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.
Hello,
I've been tasked to create a systems document or developers' guide. I'm
actually documenting a pathway that encompasses a variety of systems and
processes. My question to you is what goes into a "good" systems guide?
Are there standard pieces that should be included? This is my first one
of this magnitude (I've only done individual systems thus far) and could
use some guidance. So far, I have the following outline:
I. Summary Description
A. Business Overview
B. Operations Overview
C. Architecture Overview
D. Pathway Monitoring & Capacity
II. Use Cases
III. System Descriptions
IV. Database Descriptions
V. Infrastructure Overview
Am I missing anything?
Thanks for your help in advance,
Bridget Fitzgerald
Thomson West mailto:bridget -dot- fitzgerald -at- thomson -dot- com
Now Shipping -- WebWorks ePublisher Pro for Word! Easily create online
Help. And online anything else. Redesigned interface with a new
project-based workflow. Try it today! http://www.webworks.com/techwr-l
Doc-To-Help 2005 now has RoboHelp Converter and HTML Source: Author
content and configure Help in MS Word or any HTML editor. No
proprietary editor! *August release. http://www.componentone.com/TECHWRL/DocToHelp2005
---
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- techwr-l -dot- com
Send administrative questions to lisa -at- techwr-l -dot- com -dot- Visit http://www.techwr-l.com/techwhirl/ for more resources and info.