Hardware and software documentation analysis, strategy, standards, and production.
Style guides, doc templates, build configs, and AI prompts for writing and generating standardized developer guides and API docs.
A review of the quality, coverage, and target audience of your existing documentation, followed by a roadmap for optimizing it.
Developer guides, API reference docs, landing pages, and navigation written by expert technical writers.
A unique package that is not offered by other agencies. This package includes custom style guides, doc templates, build configs, and AI prompts for writing and generating standardized developer guides and API docs. Use these resources to scaffold initial documentation, so technical writers can focus on high-priority and complex work, and engineers can focus on engineering.
Documentation style guide
Voice, grammar, terminology, localization, accessibility
API reference style guide
Reference-specific writing, detail level, cross-referencing
API naming guide
Resource naming, verb and particle conventions, casing, versioning
Documentation templates
Quickstarts, concepts, tasks, tutorials, API reference
AI prompt library and generation workflow
Style guide and template integration, doc scaffolding
Automated linting and quality gates
Vale config, spell-check, terminology, template conformance
A review of the quality, coverage, and target audience of existing documentation. This is followed by an audit report, and a roadmap for optimizing your documentation.
Quality and accuracy
Clarity, readability, correctness, examples, links, graphics
Coverage and gaps
Audience, features, concepts, tasks, scenarios, APIs
Information architecture
Navigation, discovery, search
Style and consistency
Voice, tone, terminology, naming (including APIs), formatting
Audience and developer journey
Personas, goals, scenarios, tasks
Plan navigation and structure
Top-level structure, navigation, search
Content model and scope
Doc types, scope, deliverables, scaling
Lifecycle and ownership
Doc lifecycle, contributer workflow, content ownership, policy
Strategic and tactical writing from veteran technical writers including creating developer guides, API reference docs, landing pages, and navigation.
Developer guides
Overviews, quickstarts, tasks, tutorials
API reference docs
Endpoint and element reference, examples
Developer landing pages
Product positioning, entry points, dev community integration
Navigation and TOC
Sidebar, TOC, cross-linking patterns, search and discoverability
Restructure and migrate
Page splits and merges, reading order, format migration
Deprecation and pruning
Outdated and superseded content, redirect strategy
Optimize your developer documentation
Tell us about your documentation needs, and what packages interest you.
