Re: System Documentation Metric

Subject: Re: System Documentation Metric
From: LORITWR -at- aol -dot- com
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Wed, 1 Nov 2000 01:05:44 EST

In a message dated 11/1/00 12:17:09 AM Eastern Standard Time,
claritydocs -at- earthlink -dot- net writes:

<< In a task-based user manual for a new software system, how many pages of
documentation do you typically write for each unique system screen? (In
other words, I'm looking for a sample pages-per-screen metric) >>

A lot depends on the complexity of each screen. If you have a GUI
requirement, you can identify the types of screens. For example:

simple (fewer than 10 fields)
medium 10-20 fields
complex (more than 20 fields)

Another clarifying issue is screen organization: field containers or just a
whole bunch of fields on the screen with no obvious organization.

Then, I would use a basic approach of about 2 pages for simple screens, 4
pages for medium screens, and 6 or 8 pages for complex screens. These page
counts should allow for some introductory information, field definitions, and
procedures. Others may want to adjust some of these numbers, but I think
they provide a good starting point -- at least for a "rough estimate."

Lori Corbett

Learn how to develop HTML-based Help with Macromedia Dreamweaver!
Dec. 7-8, 2000, Orlando, FL -- $100 discount for STC members. or 800-646-9989.

Sponsored by SOLUTIONS, Conferences and Seminars for Communicators
TECH*COMM 2000 Conference, Help Technology Conference, and more or 800-448-4230

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 for more resources and info.

Previous by Author: Re: And finally, the sign-off was...
Next by Author: Print Services Recommendations
Previous by Thread: System Documentation Metric
Next by Thread: [no subject]

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

Sponsored Ads