technical-writing

To write technical documentation readable by humans and AI, use YAML front matter with name and description fields, then structure content using dual-audience patterns for tutorials, how-tos, references, and ADRs to ensure consistent parsing.

An ADR should include YAML front matter with name and description, followed by structured sections that define the problem, features, and a concise quick-start example to maintain consistency and reusability across software projects.

Create a README by starting with a front matter block containing name and description, then write clear sections for the problem, features, and a concise quick-start example to make it processable by AI and readable by humans.

Yes, this approach works for API docs and changelogs by applying dual-audience documentation patterns and front-matter conventions to improve consistency, reusability, and maintainability across the software lifecycle.

The best way to structure tutorials and how-tos is to follow audience-aware documentation types using structured sections and front-matter conventions, ensuring the content is clear, actionable, and maintainable for both human and AI readers.