bmad-os-diataxis

To refine technical writing with the Diataxis framework, apply structural validation and style-guided editing to shape content as tutorials, how-to guides, explanations, or references based on document purpose. This ensures prose matches local conventions and audience needs.

The best way to update markdown documentation is to read the project style guide first, then apply targeted prose polishing and layout fixes to align existing files with local formatting conventions without changing the underlying meaning.

Fix formatting issues in a how-to guide by applying targeted document repair that corrects layout and structure while preserving meaning. Prose refinement adjusts readability and flow without altering the original technical instructions.

You need to restructure a tutorial when the content focuses on learning pathways, whereas a technical reference is needed for informational lookup. Diataxis-aware editing classifies and shapes content based on these distinct user purposes.

Yes, the documentation skill works with existing markdown files and glossaries by reading the repository's documentation conventions and applying structural validation to refine and fix content across the project.

Yes, you can convert a rough draft into a structured Diataxis explanation by specifying the desired document type. The skill rewrites the copy to fit the right audience and follows the project style format.