Technical Documentation Project

 

Setting Up a Technical Documentation Project

Setting measurable goals throughout the process. (Milestone)

A typical documentation project has four steps:

  1. Understand the project
  2. Evaluate the project
  3. Establish the documentation process
  4. Complete the project

Understand the project

Every technical writing job is different.

The first step is to understand your requirements.

Here are a few of our standard questions:

Evaluate the project

After we establish the requirements of the documentation suite, the second step is to determine if we have the available resources to complete your project satisfactorily.

If we are not convinced we can fulfill your requirements, we will decline the project.

Establish the documentation process

When we are certain we can produce what you want, the next step is to work out a process to achieve it.

There are two main facets in the documentation process:

A project milestone is an interim deliverable (e.g. a draft copy) submitted on a specified date.

Project milestones enable accurate tracking of documentation progress.

A review cycle is the time needed to review a section of the documentation.

Review cycles containing only small sections of documentation do not over-burdened your workload. They also identify false premises at the outset, which reduces re-writing, re-reviewing and helps keep the project focused.

Complete the project

After we are in agreement with the scope of work and how to achieve your project goals, the final step is to complete the task to your satisfaction.

For information about how we can improve
your documentation, contact Devonia Inc at:
Telephone: 613.878.6800  
1.866.241-9077 *
eMail: manager@devonia.com
(* Toll-free in continental North America)