Our client delivered some major infrastructure upgrade work for a World Bank project in the Pacific region.
As part of the handover, they were required to provide a comprehensive manual for the civil, mechanical, and electrical works they’ve completed. The manual had to include a range of documents, such as:
- as-built drawings
- quality testing records
- certifications
- warranties, and
- operational and maintenance procedures.
The challenge
A lot of the equipment installed had their own manuals of varying length and quality. In addition, our client needed to document the maintenance requirements for their own work. The initial draft simply directed users to multiple appendices that had the manufacturer’s instructions which made it hard to follow.
Our approach
We worked with our client to design a structured manual that was fit-for-purpose for its target users. Due to the site’s limited connectivity, the manual also had to be print-friendly.
Our writer combined information from multiple complex documents into a cohesive manual. The primary target users used English as a second language. It was essential that we rewrote instructions in plain English and provided as many visuals as possible. We also made sure routine maintenance schedules for each component were clear and highlighted.
Each module went through a thorough review process involving our client and their own client. This ensured the manual was meeting contractual obligations and international standards.
The result
Our writer went through hundreds of pages of material, identified gaps to resolve, and did her own research to understand the work involved. As a result, our client was impressed with our writer’s independence during the development process, despite not being a subject matter expert herself. They were also happy with the quality of her work.
It was an ongoing construction project, and our client already had a lot on their plate. Leaving us to focus on producing a high-quality manual enabled their engineers to focus on site commissioning and ensure a smooth and compliant handover process.
Comments are closed.