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.
Subject:Help or User Manual First? From:Alexander Von_obert <avobert -at- TWH -dot- MSN -dot- SUB -dot- ORG> Date:Sun, 4 May 1997 23:53:04 +0100
Hello,
* Antwort auf eine Nachricht von guruk -at- GIASBM01 -dot- VSNL -dot- NET -dot- IN an All am 30.04.97
gg> I have been asked to write a user manual and help for a banking
gg> application (PowerBuilder). Normally, I feel the user manual
gg> should be written first and then the Help can be created by
gg> using
gg> the stuff from the user manual. I am interested in knowing
gg> what is the best way to handle this situation.
you see a problem where I see none: Put the stuff appropriate for paper
documentation on paper and the information appropriate for online to Winhelp
(or what you use).
The user might need some paper to install the program and to do his first
peeks into it. You might be able to write that well ahead. Put most of the
rest
into the online documentation. Hardly anyone reads paper anymore...
TECHWR-L (Technical Communication) List Information: To send a message
to 2500+ readers, e-mail to TECHWR-L -at- LISTSERV -dot- OKSTATE -dot- EDU -dot- Send commands
to LISTSERV -at- LISTSERV -dot- OKSTATE -dot- EDU (e.g. HELP or SIGNOFF TECHWR-L).
Search the archives at http://www.documentation.com/ or search and
browse the archives at http://listserv.okstate.edu/archives/techwr-l.html
