Re: Necessity of Doc Plans for a Single Chapter or Section

[Andrew Plato <intrepid_es -at- yahoo -dot- com>]

"tekWriter tekWriter" wrote...
 
> I would like to know whether or not it is typical to create a complete
doc 
> plan for a single chapter or even a sub-section of a chapter. For
example, 
> if I had to doc a new feature that needed to be added to an existing
guide 
> or manual.

No. For such a small amount of work, there is no practical reason to write
a doc plan. Unless you need to satisify the weasel-like nitpicking of
bureaucratic buttheads, just do the work. Results speak much louder than
intentions. 

If the doc turns into 5 chapters, as Steve Jong fears, then you do that
work as well. You are the technical writer, it is your job to write
documentation. If your superiors demand more work, then you should do it.
If they demand an unreasonable amount of work, then the problem is bad
managers or you failing to communicate with them. And a long, complex,
intricate doc plan won't help matters. You need to communicate in a matter
of fact manner...

PM: "I need you to do 5 more chapters"
YOU: That will add 4 weeks to the timeline.
PM: Thats not acceptable.
YOU: Then I cannot do 5 more chapters. We'll have to come up with a
different solution. 

Writing an elaborate plan that is promptly shuffled off on to some file
server won't be any help. You have to handle situations right then an
there in a realistic and forthright manner. 

Doc plans should always be used for you - not for others. They should give
you a road map, outline, and timeline. They should be a limited collection
of information that focuses you on working more efficiently. If you are
constantly writing CYA type doc plans, you're going to be treated like a
CYA type of employee. And generally, CYA people are the first out the door
in "belt tightening" times. 

Andrew Plato  

__________________________________________________
Do You Yahoo!?
Find the one for you at Yahoo! Personals
http://personals.yahoo.com

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Collect Royalties, Not Rejection Letters! Tell us your rejection story when you 
submit your manuscript to iUniverse Nov. 6 -Dec. 15 and get five free copies of 
your book. What are you waiting for? http://www.iuniverse.com/media/techwr

Have you looked at the new content on TECHWR-L lately?
See http://www.raycomm.com/techwhirl/ and check it out.

---
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.