Methodology

We have a unique approach to the planning and production of documentation for clients. To ensure that you receive the best possible documentation, our approach is based on two phases:

Planning phase
To plan a documentation project we produce a documentation synopsis which normally takes about a week. We undertake this activity for a fixed price. The synopsis forms a terms of reference for the project and defines what both parties expect from the project.

A typical synopsis might include:

Background and Scope of the project.
Recommendations about structure of your documentation set.
Suggestions for the approach to the documentation.
Assesment of any existing documentation.
Recommendations for document layout and style.
Identification of information sources and clarification of work methods.
Suggestions about On-line and quick reference material.
Initial time and cost estimates.
A detailed contents list for each deliverable.
When the documentation synopsis has been completed, the author and project manager meet with the client to discuss and finalise the recommendations made in the synopsis. This completes the planning phase of the project.

The following diagram explains the planning phase of documentation.

Production phase
The second phase of the project is concerned with producing documentation to meet the criteria set at the planning phase.

Researching: The author gathers information by using the system, reading existing documentation and interviewing key staff, often at client sites.

Writing and Illustrating: When enough information has been gathered, each chapter is developed to first draft stage.

Reviewing and Editing: The first draft is reviewed and edited for adherence to the in-house standards and is then reviewed by client for technical accuracy.

Rewriting: Any changes the client wishes to be made are incorporated.

Final Draft: Chapters are given a final review and edit before being accepted and signed off.

Translation: Language translation is undertaken if necessary.

Other deliverables: Production of related On-line and quick reference material.

Binding and Printing: Can be managed by Writelines, as can the design of cover inserts and tab dividers.

Archiving: The project is supplied on disk to allow reprints and updating.

We can manage the whole process, from initial concepts and planning to all aspects of writing and the eventual organisation of printing, binding and circulation.