Software Manual Overview

Subject: Software Manual Overview
From: "tom -dot- green -at- iwon -dot- com" <tom -dot- green -at- iwon -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Tue, 11 Jun 2002 12:59:43 -0400 (EDT)

OK, just returned from the archive and couldn't find anything on this so here goes. I have been offered a full-time, lone Tech Writer position in a company the also offers travel to do onsite training. The main documentation is a Software manual and little else at this point,although they are open to anything that will enhance the documentation process. I have done a couple of software manuals but my main strength has been Maintenance, Operations and Hardware manuals. I guess what I'm asking is what chapters/sections constitute a "quality" Software manual. I have my own experience and samples of other manuals but if you can provide some other cool insights, I will appreciate it very much.

The audience in this case is probably varied levels of knowledge.

This may not be a lot to go on but I just need a basic breakdown of what to look at to get started.

Tom Green

Technical Writer


Can a Web portal forever change your life?
Win up to $25 Million on iWon - click here!

Check out RoboDemo for tutorials! It makes creating full-motion software
demonstrations and other onscreen support materials easy and intuitive.
Need RoboHelp? Save $100 on RoboHelp Office in May with our mail-in rebate.
Go to

Your monthly sponsorship message here reaches more than
5000 technical writers, providing 2,500,000+ monthly impressions.
Contact Eric (ejray -at- raycomm -dot- com) for details and availability.

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 for more resources and info.


Previous by Author: RE: Life After Tech Writing (Possibly OT, But I Hope Not)
Next by Author: RE: First time interviewer!
Previous by Thread: RE: Acrobat Query
Next by Thread: RE: Software Manual Overview

What this post helpful? Share it with friends and colleagues:

Sponsored Ads