RE: How to estimate documentation needs?

Subject: RE: How to estimate documentation needs?
From: "Sharon Burton" <sharon -at- anthrobytes -dot- com>
To: <yzlpalypvhtc -at- spammotel -dot- com>, <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Mon, 16 Feb 2009 06:09:27 -0800

Write an information flow and personas during this period.

The information flow is the big picture of the flow of information at each
step - this is going to identify for you where and information is moving and
should also tell you when and what docs are needed.

Personas fall out of where the information is and who is using it.

These may also lead to scenarios, which are also very useful.

All these docs are useful to the company, as they identify who and how as
well as document how the information is moving thru the system. It may
clarify for them how the system works.

I'd start there, anyway.

sharon

Sharon Burton
951-369-8590


-----Original Message-----
From: techwr-l-bounces+sharon=anthrobytes -dot- com -at- lists -dot- techwr-l -dot- com
[mailto:techwr-l-bounces+sharon=anthrobytes -dot- com -at- lists -dot- techwr-l -dot- com]On
Behalf Of Petko M
Sent: Monday, February 16, 2009 1:05 AM
To: techwr-l -at- lists -dot- techwr-l -dot- com
Subject: How to estimate documentation needs?



Guys,

What would be your approach to estimating the documentation needs for
somebody
who has developed a product but has no user documentation for it and has no
clear idea what this documentation should be?

[snip]

Now, with regards to all this, I have two questions:

1. What would be your approach to estimating the documentation needs for
such a
prospect?
(Of course, a lot depends on the specifics, but what I am asking here is
about
the general approach and guidelines.)

2. How do you handle the initial non-productive period when staring a new
gig
so that your client/boss does not get nervous waiting for your output?
(Sure, this initial period is the most crucial part of a project since your
whole understanding of the product depends on it and the longer this period
is
the better documentation will be produced, but surprisingly often this is
quite
hard to grasp for the person who signs your paycheck and they insist on your
becoming productive as soon as possible.)

Petko M

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

ComponentOne Doc-To-Help 2009 is your all-in-one authoring and publishing
solution. Author in Doc-To-Help's XML-based editor, Microsoft Word or
HTML and publish to the Web, Help systems or printed manuals.
http://www.doctohelp.com

Help & Manual 5: The complete help authoring tool for individual
authors and teams. Professional power, intuitive interface. Write
once, publish to 8 formats. Multi-user authoring and version control! http://www.helpandmanual.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-unsubscribe -at- lists -dot- techwr-l -dot- com
or visit http://lists.techwr-l.com/mailman/options/techwr-l/archive%40web.techwr-l.com


To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com

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

Please move off-topic discussions to the Chat list, at:
http://lists.techwr-l.com/mailman/listinfo/techwr-l-chat


References:
How to estimate documentation needs?: From: Petko M

Previous by Author: RE: Madcap Flare and unhandled exceptions
Next by Author: Re: Uplifting reading: Why Technical Writing Jobs Are Among the Best Writing Options in an Economic Depression?
Previous by Thread: How to estimate documentation needs?
Next by Thread: How to estimate documentation needs?


What this post helpful? Share it with friends and colleagues:

Sponsored Ads


Sponsored Ads