doc-writer

To write concise technical documentation, apply a readers-first approach that prioritizes essential information, scannable prose, and working examples. A template-driven workflow enforces structured frontmatter and consistent formatting across all project files.

The best way to structure ARCHITECTURE.md or README files is using predefined templates that enforce structured frontmatter and emphasize compact, readable prose. This ensures documentation remains scannable and maintainable across software projects.

Generate API docs and tutorials with consistent formatting by applying a template-driven workflow that uses predefined reference structures. This maintains uniformity across reference materials while emphasizing concise, reader-friendly writing.

Yes, this documentation approach includes guardrails for updating existing docs, featuring specific anti-patterns to avoid and support for versioned changes. This ensures updates remain concise and prevents degradation of existing reference materials.

Use a template-driven workflow for software documentation when you need to produce high-quality, maintainable reference materials like API docs and tutorials. It solves the problem of creating inconsistent, verbose documentation that fails to remain scannable.