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.
> What would consitute a list of deliverables for a
> product. I have listed some below.
>
> Deliverables
>
> Read Me
> Installation Guide
> Getting Started Guide
> Actual Online help
Depends entirely on the product. I don't see a User Manual, but perhaps
the presence of online help negates that. Many products do not have online
help. Think about the variety of documentation formats that exist, and
decide what is applicable for the product you're documenting, for example:
user manual
system administrator manual
online tutorials
quick reference card
release notes (might be encompassed in the ReadMe)
ToolTips (popup screen tips)
etc.
Good luck!
-Keith Cronin
_____________________________
Until you finish writing the Adobe Manual of Style, quit complaining about
the Microsoft Manual of Style and get back to work, you.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Buy RoboHelp Office in May and you'll save $100 with our mail-in rebate.
Or switch from Doc-to-Help or ForeHelp to RoboHelp Office for only $499.
Get the help authoring tool PC magazine recently awarded a perfect score!
Go to http://www.ehelp.com/techwr
Free copy of ARTS PDF Tools when you register for the PDF
Conference by April 30. Leading-Edge Practices for Enterprise
& Government, June 3-5, Bethesda,MD. www.PDFConference.com
---
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.
