documentation-standards
CommunityAutomate clear, consistent documentation, effortlessly.
Software Engineering#code quality#developer tools#documentation#technical writing#code comments#standards#README
Authorphrazzld
Version1.0.0
Installs0
System Documentation
What problem does it solve?
Inconsistent, outdated, or missing documentation leads to confusion, wasted time, and increased onboarding costs. This Skill provides a universal framework to ensure all documentation is clear, effective, and easy to maintain.
Core Features & Use Cases
- "Why Not What" Principle: Guides you to write comments that explain reasoning, not just restate code, making code reviews faster and understanding deeper.
- README & Technical Docs Structure: Provides clear guidelines for essential documentation types (README, ADRs, Changelogs), ensuring every project has a solid foundation.
- Documentation Maintenance: Offers strategies for keeping documentation current and avoiding stale information, saving future developers from misleading guides.
- Use Case: When reviewing a pull request, activate this Skill to automatically check if comments explain "why" instead of "what," if the README is up-to-date, and if any breaking changes are properly documented.
Quick Start
Apply the documentation-standards skill to review the attached code and its README. Focus on comment quality and README structure.
Dependency Matrix
Required Modules
None requiredComponents
Standard package💻 Claude Code Installation
Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.
Please help me install this Skill: Name: documentation-standards Download link: https://github.com/phrazzld/claude-config/archive/main.zip#documentation-standards Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
Agent Skills Search Helper
Install a tiny helper to your Agent, search and equip skill from 471,000+ vetted skills library on demand.