HomeCurriculumTechnical Writing

Technical Writing

Developer documentation, API reference guides, architectural decision records (ADRs), code tutorials, and Markdown workflows.

1Audience Analysis & Information Architecture

Diátaxis framework, cognitive load theory, Flesch-Kincaid readability formulas, and information hierarchy.

Audience Analysis & Information Architecture

Master developer persona mapping, the 4-quadrant Diátaxis documentation model, and readability scoring mathematics.

2API Documentation & Developer Portals

3-column layouts, interactive reference specifications, Code-to-Doc reflection pipelines, and RFC 7807 error catalogs.

API Documentation & Developer Portals

Learn API reference architecture, 3-column interactive documentation design, docstring reflection, and webhook documentation.

3Architectural Decision Records (ADRs) & Specs

Nygard ADR format, RFC consensus building, Institutional Amnesia prevention, and superseding DAG lifecycles.

Architectural Decision Records (ADRs) & Specs

Master Architectural Decision Records, collaborative RFC engineering workflows, and managing decision history as a DAG.

4Docs-as-Code Workflows & Static Site Generators

Static Site Generator pipelines, Vale prose linting, automated Markdown link checking, and DocTest sandboxes.

Docs-as-Code Workflows & Static Site Generators

Implement Docs-as-Code pipelines, Vale prose linting, Markdown AST transformation, and automated link integrity testing.