After completing this course, the student should be able to:
 

	Name the qualities of a good documentation writer
	Follow the four step process for writing documentation
	State the things to consider when planning a project and why it is important to plan
	State how to gather information on the reader's job and the subject
	Complete a task analysis
	Follow the guidelines for testing and reviewing documentation

Planning the Project
Discusses what to consider when planning and why it is important to plan a project.  Examines how to answer three essential planning questions.
 

	The Documentation Writer The qualities a documentation writer needs.  Rules to guide documentation writing.  The four steps of writing documentation.
	The Importance of Planning Understanding the planning process.  Identifying the three planning questions.
	Knowing Your Resources The three basic resources: time, people, money.
	Defining the Scope and Audience How to define the scope and audience.
	Using a Scope Definition Report How to complete a Scope Definition Report.  Establishing a workable schedule for completing the project.

Gathering Information
Covers how to get information about the reader's job by doing a task analysis and how to get information about the subject.
 

	About the Reader Finding information about the reader by doing a task analysis.  The three parts of a task: input, process, output.
	About the Subject The three sources of information about a subject: people, paper, play.

Organizing Information
Examines the rule for deciding what information to include and how to sequence it.  Covers five organizational sequences.  Examines how to divide the documentation into sections and subsections.
 

	Selecting Information Selecting what the reader needs to know.  Organizing the information into a useful sequence.
	Organizing the Documentation Using the five organizational sequences: subject, difficulty, chronological, importance and analytical.
	Dividing Into Sections Dividing documentation into chapters or sections.
	Dividing Into Subsections Dividing sections or chapters into subsections.

Writing Your Documentation
Covers four main rules for writing documentation.  Discusses editing drafts and writing online documentation.
 

	Writing in Active Voice Using active voice in documentation.
	Giving the Consequences Giving the consequences of the reader's action.
	Writing from General to Specific Designing the documentation from general to specific.
	Striving for Consistency Using style, order and format consistently.
	Writing and Editing Drafts How to write and edit drafts appropriately.  Three different editing levels.
	Writing Online Documentation Definition of online documentation.  Guidelines for writing online documentation.  Using appropriate techniques to emphasize text.

Finalizing Your Document
Covers reviewing and testing the document, generating the glossary and index and formatting the document for final production.
 

	Reviewing and Testing How to select a reviewer for the documentation.  Providing the reviewer with adequate information.
	Generating the Glossary and Index How to compile a glossary.  How to generate an index.
	Formatting and Production Developing a good design for the documentation.  Choosing effective formatting options.  Selecting an appropriate binding style.

To take this course, you need the following materials:

Student, Administrator and Installation Guides