write-technical-docs

You generate developer documentation by transforming approved designs, schemas, or research packets into READMEs, API references, and tutorials. The process uses a plan-draft-review loop with strict style gates to ensure audience-aware structure and runnable samples.

Writing API references and tutorials from codebases requires enforcing doc-type decisions and audience-aware structure. This approach provides runnable samples with full imports and version pinning, alongside a rigorous review workflow to maintain accuracy.

Yes, you can turn research summaries into developer-facing guides. The system transforms research outputs into publication-ready documentation while preserving source attribution and boundaries for engineering teams.

Yes, this documentation workflow supports runnable code samples with version pinning. It enforces strict style gates that require full imports and version pinning in samples to ensure developer accuracy and accessibility.

You should not use automated writing standards when your input lacks approved designs, schemas, or structured research packets. The documentation process requires defined source material to enforce its doc-type decisions and audience-driven structure effectively.

The plan-draft-review loop works by establishing writing protocols for multiple doc types, drafting content with a consistent template, and applying strict style gates. This maintains quality and ensures readers get fast, precise guidance from varied inputs.