Documentation Plan Checklist

Home Page
The Author
Instructor.Resources
Student.Resources
Programs

iChat
Message Board
Buy the Book

 

Documentation Plan Checklist

The Overall Plan

q     Does the documentation plan contain elements to ensure its persuasiveness? (executive summary, goal orientation, persuasive figures, team orientation)

The Design Plan

q     Adequate user descriptions

q     Objectives for the documentation set

q     Descriptions of print and online documentation types

q     Outlines of individual documents (tasks and topics grouped according to user actions)

Specifies layout clearly for the following elements:

q     page size

q     columns

q     tables

q     body text style, size, font

q     sections and headings

q     task and topic names

q     steps

q     cuing patterns

q     notational conventions

q     binding and packaging

q     special layout

The Project Plan

Schedule includes all events occurring during the development process.

q     Meetings

q     Deadlines for drafts

q     Project report due dates

q     Test completion dates

q     Review deadlines

q     Editing deadlines

Schedule includes the list of resources.

q     Personnel on the team

q     Budgets

q     Computers, servers, and other equipment

q     Testing facilities and meeting rooms

q     Software for writing and authoring

q     Time/page estimates

This page maintained by Thomas Barker thomas.barker@ttu.edu  Hit Counter  Copyright © 2003 Pearson Education, publishing as Longman Publishers  Legal Notice