AI solutionsShared across all subject areas

Documentation Generation Agents

Produces API documentation, architecture descriptions, runbooks and change summaries from code and history.

Description

Generates and maintains technical documentation from the codebase and its history, addressing the reality that documentation is written once and diverges immediately.

When it fits

API reference, change summaries, and architecture description of systems that have outgrown their documentation.

When it does not fit

Documentation carrying design rationale. Why a decision was taken is not recoverable from the code that resulted from it.

Governance requirement

Generated documentation must be marked as generated and dated, so a reader knows whether it reflects the current state.

Characteristic failure

Describing what the code does while omitting why, producing documentation that is accurate and unhelpful.

Example

Maintaining API reference documentation that regenerates on each release, alongside hand-written rationale that does not.

AI solution components3
  • API Reference Generator
  • Change Summary Synthesiser
  • Staleness Detector
AI opportunity solutions

Deliberately empty

Two different absences share this shape. Foundational solutions get built whatever the domain, so no domain links them; the rest are solutions this domain genuinely does not reach for. v_ai_solutions_unlinked separates the two.