documentation-writing

To structure software documentation with the Diataxis framework, separate content into tutorials, how-to guides, reference materials, and explanations. This skill enforces that discipline by applying the Eight Rules and providing reusable templates for each category.

The best way to create a README with runnable examples is using standardized templates that enforce frontmatter and contextual usage. This skill generates README files that link to references in your docs/ directory and include executable code blocks.

To standardize API documentation across projects, enforce consistent placement in a docs/ directory with linked references and frontmatter. This skill applies the Eight Rules to ensure proper structure and discoverable reference materials at scale.

Yes, you can generate a complete documentation skeleton from templates. This skill provides reusable templates for README files, tutorials, how-to guides, and references to accelerate authoring while maintaining Diataxis discipline.

Yes, this documentation approach works for both tutorials and reference materials by strictly separating them according to the Diataxis framework. It ensures tutorials focus on learning while reference materials provide accurate, linked API details.

Documentation structure causes confusion and high maintenance overhead when it lacks consistent placement and established frameworks. Applying the Eight Rules and Diataxis discipline with linked references reduces these issues and improve discoverability.