PRODUCT MANUALS
Did you know that on average, only 25% of the users read the product manual?
My goal is to change that.
I am committed to creating professionally crafted, bespoke manuals that are useful, accurate, and enjoyable to read.
Comprehensive Product Manuals for Marine Craft & Equipment
I offer a wide range of product manuals, including:
- Installation manuals
- User, owner’s and operating manuals
- Maintenance manuals
- Spare parts manuals
For businesses requiring Integrated Logistics Support (ILS) compliance, I ensure that manuals meet S1000D standards and are structured for seamless integration into your support system. Additionally, I offer hosting and version control to keep your documentation up to date and easily accessible.
Expertise in Marine Engineering Systems
With extensive experience in marine engineering, I have worked on manuals for:
- Propulsion systems (including waterjets)
- Commercial vessels
- Military vessels
- Advanced marine craft (including hydrofoils)
- Corrosion protection & antifouling systems
- Ballast tank systems
Compliance with Industry Standards
I create manuals that meet regulatory and industry standards, including:
- 2006/42/EC Machinery Directive
- MIL Standards
- HSC 2000 Code
- ISO 10240:2022 – Small Craft Owner’s Manual
A Refined Process from 10+ Years of Experience
My approach is based on continuous improvement and best practices, ensuring high-quality manuals that evolve with your business.
Step 1. Designing Publishing & Version Management Systems
- I define how information is structured, modularised for maximum reusability, and version-controlled.
- I analyse your product’s breakdown structure and variants to create an efficient documentation system.
- As a marine engineer, I work independently, minimising the need for input from your engineers.
Step 2. Researching Rules & Requirements
- I independently research all documentation regulations relevant to your product and market.
- I create a custom technical publications style guide to ensure consistency and compliance.
Step 3. Writing Clear & Accurate Texts
- Textual content is the backbone of every manual, covering descriptions and procedures (e.g., emergency, maintenance, operation, lifting, lay-up).
- I develop procedures based on your design specifications and vendor documents.
- I write in Simplified Technical English (ASD-STE100), a controlled language designed for clarity, especially for non-native English speakers.
Step 4. Creating High-Quality Illustrations
- A picture is worth a thousand words—but only if done right.
- I establish illustration guidelines to ensure clarity, even under emergency lighting.
- I create illustrations, warning labels, and graphical symbols.
- I can work with your STEP files, or provide a solution where your CAD data is encrypted before transfer.
Step 5. Professional Layout & Design
- I design clean, professional layouts that are easy to read and align with your branding guidelines.
Step 6. Proofreading & Translation
- Every manual undergoes professional proofreading.
- Translation is available in common languages and is done directly in the source files, ensuring seamless version management.
Step 7. Flexible Output Formats
- Manuals can be delivered in various formats, including:
- Multi-ring binders
- HTML