bmad-os-diataxis-style-fix

Correct documentation markdown files to comply with Diataxis and BMad Method style rules.

Updated Mar 7, 2026
One-click install
npx skills add https://github.com/Geargrindadmin/gg-agentic-harness --skill bmad-os-diataxis-style-fix
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: bmad-os-diataxis-style-fix
Source: https://github.com/Geargrindadmin/gg-agentic-harness/tree/main/.agent/skills/bmad-os-diataxis-style-fix
Command: npx skills add https://github.com/Geargrindadmin/gg-agentic-harness --skill bmad-os-diataxis-style-fix

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) and scripts (resource) components.

What problem does it solve?

This Skill automatically corrects documentation files to adhere to the Diataxis framework and the BMad Method style guide, ensuring consistency and clarity.

Core Features & Use Cases

  • Diataxis Framework Compliance: Organizes content into Tutorials, How-to guides, Explanations, and References.
  • Style Guide Adherence: Fixes formatting issues like incorrect headers, excessive admonitions, and long list items.
  • Use Case: You have a set of markdown files in your docs/ folder that need to be updated to match the project's documentation standards before a release.

Quick Start

Use the bmad-os-diataxis-style-fix skill to check and fix the style of files under the docs folder.

Frequently Asked Questions about bmad-os-diataxis-style-fix

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I fix markdown documentation to follow the Diataxis framework?

To fix markdown documentation for Diataxis framework compliance, apply automated style corrections to files in your docs directory, categorizing content into Tutorials, How-to guides, Explanations, and References while enforcing formatting conventions.

What is the Diataxis framework for documentation style?

The Diataxis framework is a documentation style approach that organizes content into four distinct categories: Tutorials, How-to guides, Explanations, and References, ensuring clarity and structural consistency across markdown files.

How do I enforce a style guide on markdown files in a docs folder?

To enforce a style guide on markdown files, apply targeted edits across all files within the docs directory to resolve formatting issues like incorrect headers, excessive admonitions, and long list items, generating a summary of all changes.

Can I automatically correct documentation formatting issues before a release?

Yes, you can automatically correct documentation formatting issues before a release by applying style guide rules to markdown files, ensuring adherence to content categorization and formatting conventions, and outputting a complete summary of changes.

What are common markdown formatting issues in documentation style guides?

Common markdown formatting issues in documentation style guides include incorrect headers, excessive admonitions, and long list items, which can be fixed by applying targeted edits to ensure structural guideline adherence.