Go BackBusiness Communication: Documentation

Synopsis
Business Communication: Documentation provides a systematic, step-by-step overview of the process of planning, building, and creating good documentation.

Audience
This course is for anyone who wants to improve their professional writing skills.

Time
4 hours

Product Code: BCSC03
After completing Business Communication: Documentation, the user should be able to:

Plan a documentation project
Gather the necessary information about a documentation project
Perform a task analysis
Organize documentation
Format standard components of documentation
Write clear and effective documentation

Planning the Project
The documentation writer
The importance of planning
Knowing your resources
Knowing your audience
Defining the scope
Compiling a Scope Definition Report
Setting your project schedule

Gathering Information
The reader
The subject

Organizing Information
Selecting information
Organizing the documentation
Sections
Subsections

Writing Your Documentation
Writing in active voice
Giving the consequences
Writing from general to specific
Striving for consistency
Writing and editing drafts
Writing online documentation

Finalizing Your Document
Reviewing and testing
Generating the glossary and index
Formatting and production

This course has the following features:

A course index
A glossary
A Skill Assessment


 

Go Back