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.
I specialize on larger-scale systems. My basic steps
are as follows. Please note that I may be kind of
unique in placing such a heavy emphasis on data flow
diagrams - but it is a very effective approach.
1.) Create data flow diagrams showing end-user goals
and how these goals interrelate. Walkthrough
diagrams with those in the know.
2.) Decompose each of the above goals into a data flow
diagram showing essential tasks and how these tasks
interrelate. Walkthrough diagrams with those in the
know.
3.) While doing 1 and 2, create entity relationship
diagrams showing essential data relationships.
4.) Decompose each task from step 2 into a list of
implemented features. At this point, you have done
all the hard work; you have an overall design for your
documentation, whatever the delivery mechanism is.
Additionally, you have a pretty tight overall
architecture into which you can "pigeon hole" all of
the technical details.
ROBOHELP X5: Featuring Word 2003 support, Content Management, Multi-Author
support, PDF and XML support and much more!
TRY IT TODAY at http://www.macromedia.com/go/techwrl
WEBWORKS FINALDRAFT: New! Document review system for Word and FrameMaker
authors. Automatic browser-based drafts with unlimited reviewers. Full
online discussions -- no Web server needed! http://www.webworks.com/techwr-l
---
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 ejray -at- raycomm -dot- com -dot- Visit http://www.techwr-l.com/techwhirl/ for more resources and info.
