A documentation creation project is an intricate and complex process with a sequence of interrelated tasks that must be properly designed and orchestrated. Our services cover every single aspect of a technical documentation project.
Analysis of Requirements
The first step of any documentation project is to precisely define the need the document is meant to meet (describing a product, explaining procedures, easing repairs, fixing troubles, collecting data, etc)
Target Audience Characterization
The type of audience of the document must be determined (technical or novice users, prospects, etc.), along with the environment where the document will be used (during a repair, in a poster, via e-mail, on the web, when the product arrives, when setting it up, etc.), as each environment has different formal requirements.
Collection of Information
Once the scope of the project is defined, the process of collecting all the information on the product or service follows:
Collection of related documents provided by the customer
Conversations with specialists from the customer's organization
Contact with external specialists
Conversations with the target users of the documents
Research for supplementary information in bibliographic sources and the Internet
Organization of the Information Compiled
Based on the information compiled from different sources, a first conceptual outline is generated, that will be used as a reference throughout the rest of the process
Document Structure Definition
The next step is the detailed definition of the document structure, starting with an analysis from a didactic point of view, with the purpose of devising the best approach to smoothly transmit all the information to the reader
Once the structure is defined, a breakdown is created listing the different types of items, or individual work pieces, that will make up the documentation:
Descriptions of parts, components and subsystems
Descriptions of procedures
Warnings and security advices
Supporting diagrams and pictures
Tables of contents and indices
Creation of Items
Next, a detailed timeline is defined for the execution of the different items, and individual tasks are allocated to the different team members involved in the project
Coordination of the Team
During the execution phase, the partial milestones defined for the different items are strictly followed up, so as to ensure that the global deadlines are met
We apply formal quality assurance procedures and criteria specifically designed for each type of item.
Interaction With the Customer
Throughout the whole process, we keep in touch with the customer's specialists, to make sure all their instructions are strictly observed.
(c) 2009 PARÁMETRO TRADUCCIONES S.L. Registered in the Registry of Companies of Madrid, Volume 17648, Book 0, Sheet 34, Section 8, Page M-303805
Business Address: Agustín de Bethencourt 25, 5º18, 28003 MADRID. Phone 91 554 77 83 - Fax 91 761 61 42