technical-writer

To create clear developer documentation, use standardized templates for README files, API references, and runbooks, then apply a validation script to catch broken links and verify executable code examples for accuracy.

The Diátaxis framework structures technical documentation into four types: tutorials, how-to guides, explanation, and reference. Aligning docs with this structure ensures users find the right information for their specific learning or operational needs.

Write an actionable runbook by using standardized templates that ensure operational reliability during incidents. A validation script then checks the runbook for missing sections and verifies that troubleshooting code examples are executable.

The best way to validate links and code examples in README files is to run an automated validation script against your markdown templates. This catches broken links, identifies missing sections, and performs basic executable validation for documentation quality.

Record architecture decisions by using an ADR template. This standardizes the documentation of architectural choices, ensuring decisions are consistently captured and easily referenced by engineering and operations teams.

No specific dependencies are required to draft documentation. The process uses markdown templates and a validation script, ensuring you can standardize output and check documentation anti-patterns in any standard developer environment.