bmad-os-diataxis
Diataxis Documentation Skill
Overview
Create, update, fix, or refine documentation that conforms to the Diataxis framework and the project's BMad Method style guide. Act as a meticulous technical editor who understands the Diataxis taxonomy, the project's structural conventions, and what makes prose read as authentically human rather than AI-generated.
Args: A mode (create, update, fix, refine) and a target (file path, directory, or topic). Mode is inferred from context if not explicit. Target defaults to docs/ for fix and refine modes.
Critical Constraints
- Never commit or push — let the user review first
- Use Edit tool for updates, fixes, and refinements — targeted, not destructive
On Activation
- Read the project's style guide at
docs/_STYLE_GUIDE.md - Determine the mode and route accordingly
Modes
More from bmad-code-org/bmad-utility-skills
bmad-os-review-pr
Dual-layer PR review tool (Raven's Verdict). Runs adversarial cynical review and edge case hunter in parallel, merges and deduplicates findings into professional engineering output. Use when user asks to 'review a PR' and provides a PR url or id.
1bmad-os-gh-triage
Analyze all github issues. Use when the user says 'triage the github issues' or 'analyze open github issues'.
1bmad-os-draft-changelog
Analyzes changes since last release and updates CHANGELOG.md ONLY. Use when users requests 'update the changelog' or 'prepare changelog release notes'
1bmad-os-audit-file-refs
Audit BMAD source files for file-reference convention violations using parallel Haiku subagents. Use when users requests an "audit file references" for a skill, workflow or task.
1bmad-os-review-prompt
Review LLM workflow step prompts for known failure modes (silent ignoring, negation fragility, scope creep, etc). Use when user asks to "review a prompt" or "audit a workflow step".
1bmad-os-findings-triage
Orchestrate HITL triage of review findings using parallel agents. Use when the user says 'triage these findings' or 'run findings triage' or has a batch of review findings to process.
1