Skip to content
Technical documentation

O&M manuals and technical documentation, written to your spec.

Your engineers know the equipment; they shouldn't also have to write the manuals. We write O&M manuals, parts books, and troubleshooting procedures from your engineering data, route them through your engineers' review, and deliver them in the format your contract calls for.

Document types

The manuals your contract calls for.

Most equipment contracts and end-user specifications ask for some combination of the documents below. We write them for your equipment and configuration, so the writing doesn't compete with engineering and commissioning work.

Every document is tracked in one deliverables register from first draft to submission, so your project manager can see each manual's status at any point.

Two technicians reviewing conveyor drawings and manual pages at a desk overlooking the plant floor
Guarded roller conveyor carrying parcels in a sortation facility

Equipment manuals

Operator, maintenance, installation, and O&M manuals for the installed equipment.

  • O&M manuals: system operation, maintenance procedures, and reference information in one organized manual
  • Operator manuals: startup, shutdown, HMI references, alarm handling
  • Maintenance manuals: PM schedules, torque and lubrication data, illustrated tasks
  • Installation manuals: rigging, assembly, alignment, commissioning checklists

Illustrated parts books

Parts catalogs with exploded views and parts information for the required assemblies.

  • Exploded-view illustrations
  • Part numbers and quantities
  • BOM cross-references

Troubleshooting and maintenance procedures

Fault-by-fault diagnostics and standalone task procedures for maintenance technicians.

  • Symptoms, likely causes, and corrective actions
  • Step-by-step task procedures
  • Safety and lockout callouts

Technical references and job aids

Specification summaries and one-page quick references for frequent work.

  • Performance, dimensional, and electrical data
  • One-page job aids
  • Links to the relevant procedures
How it gets written

Built from your engineering data, reviewed by your engineers.

Your subject-matter experts approve the technical content; we do the collecting, writing, illustrating, and revision management.

  1. Review the specification

    Go through the documentation requirements in the specification and contract and define the deliverables.

  2. Collect input and write

    Gather drawings, BOMs, vendor manuals, and input from your engineers, then write and illustrate the documents and build the parts data.

  3. Manage reviews and revisions

    Your SMEs approve the technical content

    Route each draft to the right reviewer, track every comment to a disposition, and issue revisions under revision control.

  4. Submit and close out

    Package the approved documents in the required formats and organize them for final submission.

Working to a strict end-user standard? See how we mapped an MS Handbook and training materials to USPS requirements for Honeywell Intelligrated: MS Handbook and training support for USPS SPSS.

Next step

Scope a documentation package.

Send the documentation section of the specification, or tell us which equipment needs manuals, and we'll come back with a scope.

Helpful to include

The equipment and its configuration, the documents and formats required, and the engineering data you have.