| name | Documentation Standards |
| description | Provides guidelines for maintaining and updating documentation alongside code changes. Use this when implementing features, fixing bugs, or changing APIs that affect user-facing documentation. |
Documentation Standards Skill
This skill guides AI agents on how to maintain and update documentation when making code changes.
When to Use This Skill
Use this skill when:
- You're implementing a new feature and need to know which docs to update
- You're fixing a bug that affects user-facing behavior
- You're changing command APIs or signatures
- You're creating new templates or workflows
- You need clarity on documentation standards and structure
Key Principles
- Documentation is Part of the Feature — Update docs in the same commit as code changes
- No Historical Context — Keep all .md files clean, forward-facing only
- Specification First —
docs/SPECIFICATION.mdis the source of truth - Clear Audience Separation — User-facing vs. developer-facing sections
- Link Consistency — All references point to current locations
Files Maintained by This Skill
docs/SPECIFICATION.md— Command specifications and behaviordocs/CI_CD_GUIDE.md— User/developer CI/CD workflowsdocs/MRBGEMS_GUIDE.md— mrbgem development and usagedocs/DEVICE_TESTING_GUIDE.md— Device testing proceduresdocs/PROJECT_INITIALIZATION_GUIDE.md— Project setup guideREADME.md— Quick start and overviewAGENTS.md— This skill's documentation location
Implementation Guide
See update-guide.md in this directory for the step-by-step implementation checklist.