Re: Scoping a DocumentationProject??

Subject: Re: Scoping a DocumentationProject??
From: John Posada <jposada01 -at- yahoo -dot- com>
To: Tony Markos <ajmarkos -at- yahoo -dot- com>, techwr-l -at- lists -dot- techwr-l -dot- com
Date: Tue, 3 Jan 2006 13:53:31 -0800 (PST)

OK...here's how I do it.

I spend the first week of a project gathering, from any possible source I can, a list of every conceivable feature I can put my paws on. I'll comb existing specs or notes, speak with developers, buisiness analysts and PMs, and use my common sense and experience to know what topics I might have. For example, if I see there is a topic called X, I might figure I'll eventualy have a "Create X", "Use X", "Delete X".

Then, knowing how I write, which is to standardize on about 1/2 page per heading, I count up the items on my list and come up with the page extimate of two topics per page.

How well does this work? If, for instance I estimated 200 pages, I may end up with 150 to 250 pages. Good system? who knows...it works for me

John Posada
Senior Technical Writer
"Bigamy is having one wife too many. Monogamy is the same."
--Oscar Wilde


----- Original Message ----
From: Tony Markos <ajmarkos -at- yahoo -dot- com>
To: John Posada <jposada01 -at- yahoo -dot- com>; techwr-l -at- lists -dot- techwr-l -dot- com
Sent: Tuesday, January 03, 2006 4:38:18 PM
Subject: Re: Scoping a DocumentationProject??


John:

By "scoping out" a software documentation project, I
mean determining the "extent of" the project.

(Note: This scoping needs to be done when the TW is
not creating documentation for an already developed
(i.e., scope already firmed) product - like for
requirements specs or test plans.)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Now Shipping -- WebWorks ePublisher Pro for Word! Easily create online
Help. And online anything else. Redesigned interface with a new
project-based workflow. Try it today! http://www.webworks.com/techwr-l

Doc-To-Help 2005 now has RoboHelp Converter and HTML Source: Author
content and configure Help in MS Word or any HTML editor. No
proprietary editor! *August release. http://www.componentone.com/TECHWRL/DocToHelp2005

---
You are currently subscribed to TECHWR-L as archive -at- infoinfocus -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%40infoinfocus.com

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

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


Follow-Ups:

References:
Re: Scoping a DocumentationProject??: From: Tony Markos

Previous by Author: Re: Scoping a DocumentationProject??
Next by Author: In love with a word
Previous by Thread: Re: Scoping a DocumentationProject??
Next by Thread: Resources on estimating documentation projects


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


Sponsored Ads