Product manuals
- Leading company: NeoDoc
- Partner company(ies): IGDoc
- Customer Name: Cuenod
- Sponsoring Service: Documentation Department
- Industry: Heavy industry
- Length of project: August 2017 - March 2020
- Users affected by the solution (end user): Technician, Writers and Project Managers.
-
Customer needs:
- Filter documentation content by product and range.
- Reduce writing time.
- better manage translations
-
Services offered:
- Support in documentation production
- Training for Calenco
- Development of style sheets
- Technical writing
Methodology
-
Method used:
- Description of the method (in a few lines): Support for production and documentation management. Breakdown of documents into reusable modules. Development of style sheets Application of writing standards to documentation. Multilingual management of documentation.
-
Ressources allocated (number and function - internal or customer resource):
- Head of documentation at Cuenod
- Spare parts and documentation at Cuenod
- CEO at NeoDoc
- Neodoc Project Manager
- IGDoc Project Manager
- Technical writer at IGDoc
- Working groups/workshops needed: Document audit with IGDoc, Training in Calenco, Implementation of the document structure, filtering and reuse, Development of style sheets.
-
Tools used:
- Calenco software
-
Deliverables:
- Cuenod product manuals, PDF style sheets (white brand).
Benefits
-
Costs (ROI):
- Automating PDF publishing to avoid wasting time with manual formatting;
- Optimizing and reducing time spent to focus on the content and not style, by offering automatic style models;
- Easy creation of new documents by assembling pre-existing modules;
- Document range selection thanks to logical sorting by product, version, end-user type, etc.
-
Deadline:
- More than 50% of reduction in writing time;
- Reuse of more than 80% of existing updated content.
-
Quality:
- Standardization of structure and graphic charter for all documents regardless of the writer;
- Ensuring compliance with the propagation of changes and updates to all related documentation;
- Ensuring standardized application of the graphic and style charter for all documents produced.
-
Security:
- Reliability of information;
