Product documentation that helps you win deals

Automation leveraging robotics has redefined the traditional ways of working. The key benefits that have been instrumental in driving the adoption of automation are reliability and precision. The world’s first wall painting robot product is designed to automate the task of painting walls and ensures time efficiency and precision.


However, products like this require proper documentation to protect against hazardous situations.


The reference documentation shared by the client had limited information on operator safety instructions. Furthermore, there were inconsistencies in the naming conventions of applications and accessories. The reference documentation shared by the client also did not cover the new components added to the latest design of the paint robot.


Therefore, we identified the key challenges and documented a manual adhering to the industrial safety standards:


Key ChallengesDescription
Safety guidelines with levels of risks associated.Covered the limited safety guidelines in the documents, and the risk types.
Information completenessExisting information did not cover all the components/functionalities of the latest product model. Further, information gaps regarding accessories, prerequisites, configuration, and ‘how-to’ processes led to ambiguity.
Illustrations and ImagesLimited availability of images posed a challenge for describing processes in the User Guide and Installation Guide.
Naming conventionInconsistencies in naming conventions.

How did we solve these challenges?


We used our expertise to overcome the challenges observed in the existing documentation. Before documentation, we analyzed the current documents and information gaps and started bridging the gaps as identified. Our focus was on providing complete information that adheres to industry standards with rich graphic illustrations.


We followed the following approach for this project:



Information gathering and analysis


As the information in the existing documents was inadequate, our team held detailed Knowledge Transfer sessions with the SME on the client side. The first phase of information gathering covered notes from these sessions and an analysis of the existing documents.


Design and structure


Once the information was gathered, it was segregated into four documents:

  1. Product Overview
  2. Installation Guide
  3. Maintenance Manual, and
  4. User Guide

We designed an MS Word template that aligned with the company’s branding scheme. It was used and maintained across all the documents, including the final DITA output.


Content development


In this phase, the information gathered was refined and added to the documents. In this phase, we developed images using CAD files and added the callouts. Based on requirements, different general images, as and when required, were also developed and added by our team members. 


Reviews


To ensure the highest quality of services, we had at least two internal review sessions for each document. Post internal reviews, multiple reviews happened at the client’s end. In this phase, the documents were assessed through a microscopic lens to ensure:


  • Uniformity in formatting
  • Consistency of terminologies
  • Conformity to template across documents

After incorporating all the feedback comments, final checks were done to ensure the premium quality of the documents. Once the content was finalized, these documents were ported to DITA-XML format and combined into one comprehensive Technical Manual.


Conclusion 


Technical manuals are essential for complying with industry standards and obtaining industrial accreditation, certificates, etc.


Further, with detailed guidelines and instructions, manual support is minimized, saving time and generating more business. 


We provided the client with 4 separate source files in MS Word and one comprehensive DITA output covering all the safety guidelines, features, components, and processes. To complete this project, we leveraged our expertise in DITA-XML, MS Word, and GitHub.


What can we do for you?


Our team has rich experience in meeting every technical writing need, such as content mapping, content migration from unstructured-to-structured, technical documentation, etc. With our bandwidth, we can meet any requirement and deliver premium technical writing services in a comparatively shorter period. For any queries, contact our team. You can also explore our services on our website.

Leave a Reply