Procedure How to Write a Manual!

[Richard Melanson]

 OUCH !  ;-) 

-----Original Message-----
From: framers-bounces at lists.frameusers.com
[mailto:framers-bounces at lists.frameusers.com] On Behalf Of Robert
Shelton
Sent: Monday, May 18, 2009 2:32 PM
To: Avraham Makeler; framers at lists.frameusers.com
Subject: RE: Procedure How to Write a Manual!

> -----Original Message-----
> From: framers-bounces at lists.frameusers.com
> [mailto:framers-bounces at lists.frameusers.com] On Behalf Of Sharon 
> Burton
> 
> This is easy. 14 steps: 
> 
> 1. Identify the audience
> 2. Identify the information needs of that audience (job aids, user 
> guides, and so on) 3. Identify the tasks the audience needs to do 4. 
> Identify the supporting info the audience needs to do those tasks 5. 
> Identify the best way to deliver the information (PDF, help, others) 
> 6. Create a plan that layout all this information 7. Assign time 
> estimates to the plan 8. Decide what can be cut due to time 
> limitations 9.
> Start creating the information, adapting to the changing product 10. 
> Review by others 11. Make the review changes 12.
> Build "gold" candidates 13. Deliver the finals 14. Archive the finals,

> including all planning information
> 
> Of course, these steps include a lot of embedded steps and domain 
> knowledge in our field. But these are the steps.

I think you skipped something important:

1. Hire a tech writer.

Bob
"Let what comes, come,
Let what goes, go,
Find out what remains."
Sri Ramana Maharshi
 

_______________________________________________


You are currently subscribed to Framers as rmelanson at spirecorp.com.

Send list messages to framers at lists.frameusers.com.

To unsubscribe send a blank email to
framers-unsubscribe at lists.frameusers.com
or visit
http://lists.frameusers.com/mailman/options/framers/rmelanson%40spirecor
p.com

Send administrative questions to listadmin at frameusers.com. Visit
http://www.frameusers.com/ for more resources and info.