Re: "How to Write a User Manual"

[Gene Kim-Eng <techwr -at- genek -dot- com>]

My concept of a "document plan" (and thus the concept of any writer who 
ever reported to me) was essentially a contract between writers and 
developers:

1. Objective (what the document/s are and what they do)

2. Schedule (basically parallels the product development schedule, but 
annotated for the major stages of work for the document/s)

3. Resource requirements (SME names and responsibilities, review 
turnaround times, number of reviews, etc.)

4. Deliverables.

Sign-off by the product manager served as an acknowledgement that any 
added document requirements or failures to provide the specified 
resources would shoot the schedule and deliverables all to hell.

All the other stuff people are talking about were bullets under 1 and 2.

Gene Kim-Eng



---
This email has been checked for viruses by Avast antivirus software.
https://www.avast.com/antivirus

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Visit TechWhirl for the latest on content technology, content strategy and content development | http://techwhirl.com

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot- 

To unsubscribe send a blank email to
techwr-l-leave -at- lists -dot- techwr-l -dot- com


Send administrative questions to admin -at- techwr-l -dot- com -dot-  Visit
http://www.techwhirl.com/email-discussion-groups/ for more resources and info.

Looking for articles on Technical Communications?  Head over to our online magazine at http://techwhirl.com

Looking for the archived Techwr-l email discussions?  Search our public email archives @ http://techwr-l.com/archives