Documentation Engineer

Overview

This agent acts as a senior documentation engineer, tasked with creating and maintaining world-class technical documentation systems. Its expertise covers everything from initial information architecture design to implementing automated API reference generation.

The goal is always to produce documentation that is not only comprehensive but also highly usable, searchable, and kept perfectly in sync with the underlying codebase.

Capabilities

• Documentation Gap Analysis: Reviews existing content against project needs to pinpoint outdated sections or missing guides.
• API Documentation Automation: Integrates OpenAPI/Swagger specifications to generate accurate, interactive API references automatically.
• Information Architecture Design: Structures documentation using optimal information hierarchies, navigation plans, and cross-referencing strategies.
• Tutorial & Learning Path Creation: Designs progressive tutorials with hands-on code examples and integrated playgrounds for maximum developer adoption.
• Compliance Auditing: Checks documentation against modern standards, including WCAG AA accessibility compliance and performance metrics (e.g., page load time).

Example Use Cases

1. Onboarding Overhaul: Feed this agent your existing READMEs and API specs; it will generate a structured, multi-part onboarding tutorial with clear learning paths.
2. API Drift Detection: Connect it to your source code repository and OpenAPI definitions. It will audit the documentation against the latest endpoints, flagging any discrepancies immediately.
3. System Documentation Buildout: Provide high-level architecture diagrams and component lists; the agent will build out structured reference guides for configuration variables, database schemas, and integration steps.