Tasks: First present a paragraph that describes the one bottom line task that users should be able to perform (such as install a product) and a summary of the other skills and knowledge they need.

Next list:

• Five to seven main tasks that users should be able to perform after using this communication product.
• For each main task, 5 to 7 supporting tasks--that is, tasks users must be able to perform to successfully complete a main task. (For example, to complete the main task of starting a system, users must be able to complete the supporting tasks of using the power button and entering a password.)

User groups: Describe the intended users of the proposed communication product. Provide:

• Demographics: job titles, experience, previous knowledge, and motivation for using the information (must use it, should use it, or nice-to-know)
• Character sketch of 2 or 3 typical users in that category

Project constraints: Identifies constraints on:

• Schedule (such as a firm completion date that must be met)
• Budget (such as a "not to exceed" cost)
• Quality (identifies quality standards and other issues that the proposed communication product must conform to)

Checklist of issues to consider during the needs analysis.

Top

2. Goals

Objectives: Make sure that these are stated in observable and measurable terms.

• Business objective: Explains, in observable and measurable terms, how the technical communication product will contribute to revenue, contain expenses, or comply with regulations.
• Content objectives: Same as the tasks (in a full information plan, you would provide some additional measurement information).

Evaluation: In a sentence, explain how your sponsor can observe whether the communication product has achieved its goal.

Top

3. Form of the Communication Product

Form

Given that you have been instructed to write a certain type of communication product such as a user's guide or reference, explicity name the expectations that users bring for that form. Specifically state:

• Purpose of this type of communication product
• "Must include" information
• Tasks commonly addressed by this type of communication product
• Standard structure for this type of communication product
• Writing style for this type of communication product

See Forms of Technical Communication Products for more details about the types of products available and the expectations that users bring to them.

Top

4. Describe the Function

1. Present a complete flowchart for the communication product, including:

Front matter (only include the components that apply)	Cover Inside front cover Title page Edition notice Table of contents Preface (or their equivalents in other media)
Body	Represent as an information map-a flow chart of sorts that visually shows the structure of the information (rather than an outline). When creating the information map, make each main objective a major point; and make each supporting objective a supporting point.
Back matter (include the components that apply)	Appendixes Index User Feedback Form (also called Reader Comment Form) Inside back cover Back cover or their equivalents in other media)

2. Provide a detailed, display-by-display (that is, page-by-page or screen-by-screen), description of the communication product. For each, list the following:
• Page or screen identifier
• Content and How it Will Be Presented
• Production instructions
• Programming instructions

These ideas are often best presented in storyboards or thumbnails.

Sample of a design document describing plans for the function of a technical communication product

Top

5. Quality Guidelines

Top

models | processes | techniques | resources on i.d. business and management | home

(c) Copyright. 1999, 2000, 2001, 2002. Saul Carliner. All rights reserved.