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.
> it, etc. Each writer must create a list of all possible things each
> component can do, and then create end-user documents. These
Define component.
Can you equate a component to the GUI at the level of every window,
screen, or dialog?
If so, start with an image of each element of the gui. Next, create a
template form that you can apply to each of them...maybe something
along these lines:
1) Description of the element
2) How is it invoked
3) Elements it affects or impacts
4) How is it installed
5) Process flow diagram
6) Where does it get the information it needs to act upon
7) To what process does it supply data
8) etc
9) ...
10) etc
Assign a set of these templates to each member of the writing team
and have one person responsible for making sure that by the time you
are done, there is no #3 with it being included in somneone else's #3
and that there are no #6 without a correponding #7
=====
John Posada
Senior Technical Writer
_______________________________
Do you Yahoo!?
Declare Yourself - Register online to vote today! http://vote.yahoo.com
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.