Documentation Architecture Skill

Automate API documentation by generating OpenAPI 3.1 specifications directly from your FastAPI codebase. This Skill extracts endpoint definitions, request/response schemas, and multi-language examples to produce Swagger UI documentation on every commit, eliminating manual updates.

Yes. Set automated coverage validation thresholds—such as 80%—within CI/CD to block deployments when documentation gaps exist. This Skill integrates validation checks that catch missing API docs, architecture decisions, and template compliance before merge.

Design scalable documentation architecture using integrated versioning strategies and indexed search across API docs, architecture diagrams, ADRs, and templates. This Skill consolidates multiple documentation formats into a unified, searchable system within your existing toolchain.

Yes. This Skill handles large-scale documentation by automating generation pipelines, managing multi-language examples, and enforcing consistency across distributed repositories. It scales from single services to complex microservices architectures with centralized quality control.

This Skill uses ts-morph to parse TypeScript/JavaScript source code, AST to analyze Python and language-agnostic syntax trees, and Jinja2 templating to render consistent documentation output. Together they extract code structure and generate formatted docs from source.

Inconsistencies are caught by automated validation and template enforcement within CI/CD. This Skill detects drift between versioned specs, enforces schema compliance, and flags template violations before they propagate to production documentation.