FM Global · Documentation Audit

Docs developers actually finish.

I audited API documentation against what a developer needs first, then rebuilt it around how developers really work.

Client
FM Global
Audience
Developers integrating an API
Deliverables
Audit, restructured docs, examples, error guide
The insight

Developers don't read docs. They scan for the next thing they need to do.

Good documentation answers questions in the order they come up: How do I start? How do I log in? What do I send? What went wrong? So that became the structure.

My process

How I did it

  1. Audit

    Reviewed the docs against a developer checklist: quick start, authentication, endpoints, errors, and examples.

  2. Reorder

    Rebuilt the flow to match the order a developer works, from first request to troubleshooting.

  3. Show, don't tell

    Added real request and response examples and code samples for every endpoint.

  4. Plan for failure

    Wrote error guidance that explains how to fix each problem, not just what the code means.

Before and after

From wall of text to a path a developer can follow

Before

Dense paragraphs. No clear start. Errors listed without fixes.

After
1. Quick start · Sign up, install, first request
2. Authentication · Where your key goes
Authorization: Bearer YOUR_API_KEY
3. Endpoints · Request and response for each
4. Errors · What happened and how to fix it
Illustration of the restructure. Content generalized for confidentiality.
What I delivered
  • AuditGap analysis against developer needs
  • Quick startThree steps from sign-up to first request
  • ReferenceEvery endpoint with parameters and examples
  • Error guideCommon errors with clear fixes and best practices
My role
  • Content audit
  • Technical writing
  • Information architecture
  • Developer experience

Want to see more?

Much of this work is confidential. I'm happy to walk you through it on a call.

Request a walkthrough