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.
> 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.
You're right, it's not a lot of information for us to
go on. What are you asking for? What kind of info
should go into a software manual? If so, it depends on
your audience. Seeing as your audience is varied in
skill, then your manual needs to accommodate that.
__________________________________________________
Do You Yahoo!?
Yahoo! - Official partner of 2002 FIFA World Cup http://fifaworldcup.yahoo.com
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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 http://www.ehelp.com/techwr-l
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 http://www.raycomm.com/techwhirl/ for more resources and info.
