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: How much documentation for 1000 hours of programming?
Subject:Re: How much documentation for 1000 hours of programming? From:Kent Newton <KentN -at- METRIX-INC -dot- COM> Date:Wed, 27 Mar 1996 22:04:00 PST
On Wednesday, March 27, 1996 6:32 PM, Richard Mateosian quoted an
>>For instance, if it's estimated that an enhancement to a given software
>>system is going to take 1,000 man hours to design and code; can we
>>how many hours to budget for a user manual (user only; no technical
>>reference or system admin manuals)?
He then replied"
>Your thousand-hour enhancement might be totally invisible to the user,
>change to documentation is required.
>On the other hand, your enhancement might so thoroughly change the
>relationship with the real-world application that you'll need a complete
>revision of your entire documentation set.
>There's no way to determine this information from the number of
I'll second that! I've had programmers spend several man-weeks on a
project that required a one-line change in the documentation. Then I've
had them spend one man-day adding a little field to several screens which
required a week of my time to capture the screens, clean them up, pop
them in the documentation, and add the relevant text.
Senior Technical Writer
kentn -at- metrix-inc -dot- com