Documentation Pipeline

Documentation Pipeline

Analyses source code and generates detailed technical documentation with examples, formatted as clean markdown

Brief Compliance Check

Checks output against its stated brief — required sections, constraints, and missing deliverables

Code Analysis

Analyses code for patterns, complexity, and potential bugs across common languages

Consistency Check

Checks naming, terminology, tense, voice, style, and internal coherence across a document

Defang Content

Neutralises potentially dangerous content in code snippets, URLs, and commands before display or processing

Documentation Writing

Produces technical documentation from code analysis, covering API references, guides, and module overviews

Format Conversion

Converts content between output formats: markdown, plain text, email HTML, JSON, CSV, presentation outline

Language Polish

Spelling, grammar, punctuation, sentence clarity, and minor wording cleanup

Analyse Code

Extracts structural information from source code for documentation generation

Check Brief Compliance

Verifies output meets all requirements from the original brief

Check Consistency

Checks naming, terminology, tense, voice, and internal coherence across a document

Generate Examples

Creates practical, runnable usage examples showing common patterns and workflows

Polish Language

Corrects spelling, grammar, punctuation, and improves sentence clarity

Write Documentation

Generates detailed technical documentation from code analysis output

LLM Service

Language model service for analysis, synthesis, and document generation

Documentation Standards

Reference standards for technical documentation format, structure, and content quality

Documentation Checklist

Working checklist to track documentation completeness before publication