docs-writing

You audit documentation quality by applying a structured 52-rule framework across voice, structure, clarity, and formatting to identify issues and provide concrete remediation guidance for READMEs and API references.

The Diataxis framework is a documentation standard that categorizes content into tutorials, how-to guides, reference, and explanation. This Skill applies it by auditing docs against 52 rules across 9 categories to ensure compliance and clarity.

To write new engineering docs that pass a style guide audit, draft your content and run it through the 52-rule framework, which checks voice, structure, clarity, formatting, navigation, and hygiene to produce audit-ready documentation.

Yes, you can integrate documentation auditing into CI pipelines. The Skill supports use cases like integrating audits into CI to enforce the 52-rule framework across engineering teams seeking Diataxis-compliant and clarity-driven documentation.

The best way to improve poor documentation consistency is to run a comprehensive rule-driven audit across voice, structure, clarity, formatting, navigation, and hygiene, which surfaces top issues and provides actionable guidance for remediation.

Yes, the documentation auditing framework works for tutorials and docs sites. It applies 52 rules across 9 categories to provide actionable guidance for improving various document types, ensuring clarity-driven and Diataxis-compliant results.