Preparation

Nov 4, 2012 Ξ Leave a comment

Creating the documentation plan

posted by Tenneti
Creating the documentation plan

A Documentation Plan is a broad technical writing project plan covering all the execution, schedule, and personnel details.

Once you identify your goals for the assignment and create your audience profiles after the audience, you need to prepare a Documentation Plan.

You need to create a documentation plan to achieve the following goals:

  1. To plan and track the execution of your deliverables
  2. To share your execution strategy with design, development, and other teams
  3. To track the progress of the development teams and change your plan accordingly
  4. To assign work to the various resources appropriately

You need to prepare a Documentation Plan consisting of the following parts:

  1. Introduction – It includes a brief introduction about the product/project in general. It describes the features of the current version of the software or model of the hardware.
  2. Deliverables – This section lists all the documentation deliverables and their formats. For example, you can include Online Help, User’s Guide, and Context-sensitive Help
  3. Audience – The information generated during audience analysis acts as an input to this section of the Documentation Plan. You can also include some brief information about the audience profiles.
  4. Requirements – This section lists all the writer’s requirements such as hardware requirements, software requirements, and other technical requirements to complete the assignment.
  5. Schedules – It includes all the dates and deadlines for the various stages in the life cycle.  Document managers need to decide on the dates after consulting the product management team and finding their requirements.
  6. Resource allocation – It includes the list of writers and the document deliverables assigned to them. Even though this might change during the documentation, it acts as a good starting point for including ownership.
  7. Stakeholders – This section includes the list of other stakeholders such as the management team, technical reviewers, and members of the quality assurance group.

The Documentation Plan is a working document and must be continuously updated during the different stages of the assignment. You might have to modify the dates to cater to the changing project deadlines as it often happens in typical software development life cycles.

Share This

Leave a Reply

You must be logged in to post a comment.

Log in with:

Subscribe to our Newsletter

To subscribe to Techitive newsletter simply add your email below. A confirmation email will be sent to you!

Tweets

Resources

Understanding Source Documents – E-Book

Understanding Source Documents - E-Book

July 24th, 2013

Techitive Press presents the second E-Book for ready reference - Understanding Source Documents. [...]

E-Book – Technical Writing Process – An Overview

E-Book - Technical Writing Process - An Overview

July 15th, 2013

Techitive Press presents small E-Books for ready reference. [...]

Understanding articles

Understanding articles

September 22nd, 2012

[...]

Self Review Checklist

Self Review Checklist

September 16th, 2012

Grammar Verify the text for spelling mistakes and typographical errors. Verify the text fo[...]

Search on Techitive

Subscribe on Facebook