Lucid's documentation projects evolve through two stages: the planning phase and the production phase.
The planning phase
We firstly produce a synopsis which defines the requirements and expectations for the project. This is essentially a project plan and acts as a terms of reference for the project. The planning phase normally takes about a week.
A typical synopsis includes:
- a detailed contents list for each deliverable
- an assessment of any existing documentation
- identification of information sources and clarification of work methods
- recommendations for document format
- proposals for the scope and structure of your documentation set
- suggestions for related materials such as quick reference cards
- initial time and cost estimates
When the synopsis is complete the authors and project manager meet with the client to discuss and finalise the recommendations.
The production phase
The second phase consists of producing the documentation to the criteria agreed at the planning stage.
Producing the documentation may involve:
- researching
the author gathers the information from the agreed sources
- writing and illustrating
each chapter is produced to the first draft stage
- reviewing and editing
the first draft is reviewed internally and then by the client
- rewriting
the required changes are implemented
- final draft
both parties give the chapters a final review and edit before the client accepts them and signs them off
- translation
language translation may be undertaken
- graphic design, printing and binding
can be managed by Lucid
- delivery
the project is supplied electronically to allow reprinting and updating
- archiving
on-site backups facilitate maintenance and enable recovery
We can manage the whole process, from initial consultancy through to all aspects of writing, graphic design and the eventual organisation of printing, binding and circulation.
|