Your documentation may contain all the necessary information and still leave developers unable to complete setup, understand an API, or reach their first successful outcome.

I will conduct a structured audit of your developer or product documentation to identify inaccurate instructions, missing information, broken journeys, confusing organization, and other issues that create friction for users.

This service is designed for SaaS companies, API products, developer tools, platforms, and technical teams that need an evidence-based plan for improving their documentation.

I review the documentation as both a technical writer and a user attempting to accomplish a real task. Where access and technical requirements permit, I test the documented journey instead of limiting the audit to an editorial review.

The audit can cover:

Developer documentation

API documentation

Product documentation

Quickstarts and getting-started guides

Installation and configuration instructions

Integration tutorials

SDK and CLI documentation

Knowledge bases and help centres

Troubleshooting documentation

WordPress or headless CMS documentation

Internal technical documentation

Depending on the agreed scope, I assess:

Documentation structure and information architecture

Navigation, searchability and content discoverability

Developer onboarding and time to first successful outcome

Completeness of setup and integration instructions

Technical accuracy and reproducibility

Code samples, commands, links and API requests

Prerequisites, authentication and configuration steps

Missing, duplicated, outdated or conflicting information

Terminology, voice and consistency

Readability and suitability for the intended audience

Error handling and troubleshooting guidance

Accessibility and content formatting

Documentation SEO and internal linking, where relevant

Gaps between the product experience and its documentation

You will receive:

We identify the product, documentation set, intended users, important workflows and current documentation challenges.

I map the included pages, content types and user journeys before beginning the detailed evaluation.

I follow the documentation as a user would. Depending on the project, this may include testing installation steps, configuration instructions, code examples, API requests or integration workflows.

I assess technical clarity, completeness, organization, consistency, discoverability and alignment with the product experience.

Each material issue is documented with context, evidence, impact and a recommended action.

You receive the completed audit report and a live walkthrough of the most important findings.

Every documentation system differs in size, technical complexity and testing requirements. I will provide a custom quote after reviewing your documentation, priority user journeys and required level of technical testing.

The scope may include one or more documentation platforms, developer or user journeys, API workflows, SDKs, code samples and technical environments. The agreed proposal will clearly define the pages and workflows covered, deliverables, timeline and clarification period.

Most focused audits are completed within two weeks after I receive the required access and project information. Larger documentation systems, multiple products, extensive API testing, source-code review or specialized environments may require additional time.

To begin the audit, please provide:

A link to the documentation or product

Access credentials if the documentation or product is private

A brief description of the product and target users

The primary workflow you want evaluated

Any known documentation problems or user complaints

Relevant API credentials, repositories or test environments

Existing style guides or documentation standards, if available

Analytics or support-ticket insights, if you want them considered

Please provide test credentials rather than production credentials. Remove or restrict access to sensitive information that is not required for the audit.

This service delivers an audit and prioritized improvement plan. Rewriting the entire documentation set, implementing recommendations, redesigning the documentation website, migrating content, or creating new documentation is not included in the base package.

Those services can be scoped as a separate project after the audit.

Send me your documentation link, the product’s target audience and the most important workflow you want reviewed. I will confirm whether the base package fits or whether your documentation requires a custom scope.