Milestones of a Typical Documentation Project

What is the typical workflow of a documentation project? Which milestones should you schedule when planning a technical documentation or software documentation project? What steps are required to create a user manual, an online help, file, a screencast, a demo or a tutorial?

Single tasks can always be handled flexibly. Larger documentation and online help projects typically involve the following milestones:

You ask the documentation service provider whether they’re qualified and have the time to handle your project.

To make a bid, the documentation service provider will mostly need some more detailed information which can best be given in a short telephone or personal conversation. To prepare this, it’s helpful if you can provide some information about your product in advance (such as specifications, sales material, demo versions, etc.). If existing documents are to be completed or updated, the service provider will also need the possibility of taking a look at these documents.

Documentation service providers will usually base their offers on a preliminary time estimate. With larger projects there typically several approaches to a solution. Often, it can be only determined as a result of an in-depth target group analysis which one of the alternatives is the most recommendable one.

Only after you’ve decided on a specific alternative the cost of authoring and implementation can be calculated reliably and in detail. For this reason, many offers are split into two phases: concept and authoring.

it’s a good idea to accept the bid only for the concept at first. This leaves you an option to back out and change the contractor in case you’re not fully satisfied with their work. Also, after the concept has been agreed upon you can ask for a much more detailed and reliable offer for the authoring phase.

In either case, you should name one or more persons within your company who are qualified to answer questions about your product, its users and their goals.

If your project involves the creation of new documentation from scratch, the first step of your documentation service provider will be to work out a documentation plan (also refer to section “Do you need a documentation plan at all?” in topic Creation of New Documentation).

If possible, the concept should be presented and discussed personally. it’s important that this discussion involves your product experts as well as product management and all authors who will have to implement the concept.

Your documentation service provider will now begin authoring and finally presents the results for review and approval.

If possible, you should plan the project so that completed parts are reviewed immediately. This shortens the “throughput time” of your project and enables you to identify and counteract any systematic, recurring problems early. However, please don’t ask your documentation service provider to hand over parts that aren’t yet final. This would result in extra work on both sides.

it’s good practice to split the review task:

experts from development check for technical detail
a product manager or documentation professional crosschecks for general and formal issues

The documentation service provider implements what was decided as a result of the review, and delivers the printer’s copy or the distributable online help files.

Your final approval completes the documentation project.

Your documentation service provider should inform you at regular intervals on the progress of the project. A proven instrument are weekly status reports, which list all agreed changes and deadlines. This enables you to you monitor that everything runs smoothly within time and budget, and gives you the chance to counteract early, if required.

Keywords relating to this page: technical documentation - software documentation - documentation - user documentation - user assistance - manual - user manual - online help - documentation project - service provider - contractor - agency - office - create - creation - project - project planning - project management - project plan - project schedule - milestones - steps.

 

Imprint | Copyright | Terms of Use | Linking to Us | Acknowledgements

Subscribe to newsfeed Newsfeed

Bookmark and Share
Software user assistance since 1989.
Various publications and presentations on technical writing, technical communication, and user assistance (UA).
Winner of the Golden Disc from the German computer magazine CHIP.
Member of tekom, the German professional organization for technical communication and information development.
Show intro (80 seconds):  Play