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.
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."
Sponsored by SOLUTIONS, Conferences and Seminars for Communicators
TECH*COMM 2000 Conference, Help Technology Conference, and more http://www.SolutionsEvents.com 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 http://www.raycomm.com/techwhirl/ for more resources and info.