Documentation Plan Checklist for Technical Writers

Before starting a large documentation project, plan ahead so that all areas related to the final delivery are covered, such as costs, production, resources, dissemination, and archiving.

If you overlook this step your project's success could be undermined by failing to anticipate these items. For example:   

• Did you remember that Mary in Production Dept. is on holiday the day before release?
• Have you got sign-off for printing?
• How will you deliver the hardcopy reports?

Documentation Plan Template

Documentation Plan Checklist

This Documentation Plan describes how technical documentation will be prepared, delivered and distributed.

Tip: This is also known as an Information Development Plan

Use this template to:

• Identify the content, format, page count, size etc for each document in your next publication cycle
• Prepare cost estimates for the project duration
• Schedule resources to meet the documentation requirements
• Have greater control over your budget and ensure that risks and issues are addressed before starting the writing phase
• Identify the necessary tools/licenses/PC configuration etc
• Ensure documents are scoped correctly with the appropriate level of detail

None of these have to do with the main writing tasks, but are essential for the project's overall success, especially if it ties in with other parallel deliverables.

The following checklist offers some areas to consider before starting your project.

Your Thoughts?

What are your thoughts on this? Drop me a line at ivan at klariti dot com