Developer experience
Follow real tasks from the first setup to a working integration. Check prerequisites, instructions, examples, and recovery when something goes wrong.
Documentation
audits.
Test developer journeys, review content structure, or evaluate how AI tools use your documentation. Get prioritized findings and a plan for what to improve.
What we review
Content structure
Review navigation, user journeys, duplication, gaps, product versions, and responsibility for maintaining the content.
Use by AI tools
Check whether the selected assistant can access the right sources, find the correct version, and answer agreed questions with supporting evidence.
How the audit works
Agree the scope
Choose the audit focus, audience, documentation sample, tasks, environment, and expected results with your team.
Test and record
Work through the agreed tasks and inspect the content. Record the page, observed problem, evidence, and effect on the developer or consuming tool.
Prioritize the findings
Separate blockers from improvements. Review recommended fixes, dependencies, and a practical order of work with your team.
We tested the getting-started path.
For Weave.js, we followed the setup guides in a clean environment and traced missing prerequisites, installation failures, and examples that did not compile. The work led to revised structure, reproducible installation guides, and examples sourced from a working project.
See the Weave.js auditStart here
Documentation audit
From $5,000A defined documentation set and audit focus, scoped around the decisions your team needs to make.
- Agreed tasks and review coverage
- Evidence with affected pages and reproducible findings
- Priorities and recommended changes
- Report review and improvement plan
Custom audit
Custom quoteMultiple products, audiences, documentation sets, or specialized requirements.
- Agreed coverage across products and versions
- Custom tasks and test environments
- Stakeholder review and delivery plan
- Scope and acceptance checks agreed upfront
Questions
Do we need to review everything?
We agree a representative documentation set and the questions the audit needs to answer. The proposal defines the coverage, tasks, deliverables, and price before work starts.
Can you test our docs as a developer?
Yes. We follow the agreed onboarding and integration tasks in a defined environment, check the instructions and examples, and record where progress becomes difficult or stops.
Can the audit focus on AI tools?
Yes. AI documentation evaluation focuses on agreed questions, expected sources, version handling, and the behavior of a named consuming tool.
What does each finding include?
The affected page or task, observed issue, evidence, impact, priority, and recommended action. We distinguish tested behavior from questions that need input from your product experts.
Can you implement the recommendations?
We can scope implementation after the audit, with the report as the starting backlog. Your team can also use the findings to plan and carry out the work internally.