TechWhirl (TECHWR-L) is a resource for technical writing and technical communications professionals of all experience levels and in all industries to share their experiences and acquire information.
For two decades, technical communicators have turned to TechWhirl to ask and answer questions about the always-changing world of technical communications, such as tools, skills, career paths, methodologies, and emerging industries. The TechWhirl Archives and magazine, created for, by and about technical writers, offer a wealth of knowledge to everyone with an interest in any aspect of technical communications.
Re: Rule of thumb for doc time based on development time?
Subject:Re: Rule of thumb for doc time based on development time? From:Tony Markos <ajmarkos -at- yahoo -dot- com> To:Faith Weber - ESC <faithw -at- esystem -dot- com>, techwr-l -at- lists -dot- techwr-l -dot- com Date:Fri, 9 Dec 2005 10:30:42 -0800 (PST)
Faith:
There are no development time to pages of
documentation rules-of-thumb because, for a given set
of end-user functionality, the development time can
vary radically depending on the quality of the
developers - sometimes by more than 100 to 1.
What I would do is decompose the tasks into equal
sized pieces, each of which can be described in about
a page of text. You then simply determine how long a
typcial page takes to document and then multiply time
per page by number of tasks.
Of course the trick in the above is coming up with the
one-page task chunks. This is an analysis issue.
Create a flow diagram of the tasks. Rechunk the tasks
until they each have about the same number of input
and/or output flows. The number of inputs and/or
outputs to a task is a good indicator of task
complexity - and tasks having the same number of
inputs/outputs are roughly equivalent.
> Hi all,
>
> Have you ever worked with any rules of thumb for
> estimating
> documentation time for a project based on the
> estimated development
> time? If so, what were they? How well did they work
> for you?
>
> This is intended only for a broad estimate to be
> done before all of the
> project details are in place.
>
> The documentation involved would be task-based, and
> probably paper/PDF.
> It is for a complex product involving more than a
> dozen interrelated
> applications.
>
> BTW, it's not clear to me yet whether it's possible
> to do a reliable
> estimate on this basis without additional
> information. But I've been
> asked to provide a metric along these lines (by
> someone who has sensible
> reasons for asking), so I'm just trying to find out
> as much as possible
> before responding.
>
> In addition to any feedback you may have, I plan to
> obtain some data
> from past projects to see if a pattern emerges.
>
> Thanks!
> Faith Weber
>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
>
> 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
> ajmarkos -at- yahoo -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/ajmarkos%40yahoo.com
>
> Send administrative questions to lisa -at- techwr-l -dot- com -dot-
> Visit
>http://www.techwr-l.com/techwhirl/ for more
> resources and info.
>
>
__________________________________________________
Do You Yahoo!?
Tired of spam? Yahoo! Mail has the best spam protection around http://mail.yahoo.com
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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-