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 am on my first documentation project, and I have no solid technical
writing background. In my process of documenting a General Ledger software,
I had in mind the following:
- Start with general features.
- Go through the definitions and tasks windows by giving a simple background
and then a "How to..?" approach to explain the usage of each field.
- Add a reference part to list all icons, buttons, glossary, error and
warning messages and so forth.
The thing is that my boss, who is the software development manager, doesn't
like the "How to...?" approach and wants me to replace it with a listing of
each field, edit box or grid and a brief on its usage. I am not quite sure
that this way will be effective enough and I need your help....Any
suggestions any innovative techniques or any standardized documentation
process to adhere to.
Thanks in anticipation,
Now's a great time to buy RoboHelp! You'll get SnagIt screen capture
software and a $200 onsite training voucher FREE when you buy RoboHelp
Office or RoboHelp Enterprise. Hurry, this offer expires February 28, 2002. www.ehelp.com/techwr
You are currently subscribed to techwr-l as: archive -at- raycomm -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.