Agent skill
doc-maintainer
Maintains high-quality, concise, project-aligned documentation. Creates, updates, and validates README.md, CLAUDE.md, code comments, and other documentation. Activates after implementing features, when documentation is outdated, or when explicitly requested.
Install this agent skill to your Project
npx add-skill https://github.com/fubira/claude-code-settings/tree/main/skills/doc-maintainer
SKILL.md
Doc Maintainer Skill
Create, update, and validate documentation. Keep docs concise, accurate, and scannable.
Activation Triggers
- Documentation not updated after feature implementation (automatic)
- README.md exceeds 150 lines (automatic)
- Go public functions/types missing doc comments (automatic)
- Explicit documentation request (manual)
Documentation Standards
README.md
- 150 lines max. Describe current state only (no timeline/changelog)
- Use CI badges for dynamic metrics (never hardcode)
- Required sections: Overview, Tech stack, Setup, Structure, Features, Dev commands, License
- Prohibited: Detailed tech explanations, unused platform info, verbose descriptions
CLAUDE.md
- Prescriptive tone ("should"). Describe ideal state, not current status
- Dev guidelines in CLAUDE.md, usage instructions in README.md (separation of concerns)
Code Comments
- Go: Required for public functions/types (start with function name). Explain why
- TS: JSDoc for public APIs. Skip when types are self-documenting
- Common: Describe current behavior only. Keep only actionable TODO/FIXME
Workflow
- Analyze: Read existing docs and project CLAUDE.md, identify gaps and inconsistencies
- Verify: Check length limits, temporal info leaks, hardcoded metrics. Run
mcp__ide__getDiagnosticsfor Markdown lint - Optimize: Logical structure, important info first, consistent terminology and style
- QA: Verify alignment with codebase, validate links, test code examples
Recommended Agent Skills
Expand your agent's capabilities with these related and highly-rated skills.
fubira/claude-code-settings
refactoring-assistant
Assists with code refactoring by detecting code smells, suggesting improvements, and providing refactoring patterns. Activates when writing/editing code, explicitly requested refactoring, or when code quality issues are detected. Maintains awareness of core principles while providing detailed patterns and examples.
fubira/claude-code-settings
code-reviewer
Assists with code review by analyzing code changes for quality, best practices, security, and potential issues. Activates after implementing code features, bug fixes, or refactorings. Provides structured feedback with critical issues, suggestions, and positive highlights.
fubira/claude-code-settings
context-compactor
Analyzes and compacts context-affecting documents (project memory, CLAUDE.md, skill files) to reduce token usage and compaction frequency. Manual trigger only. Always requires user approval before making changes.
fubira/claude-code-settings
test-executor
Executes tests, analyzes test results, checks test coverage, and provides comprehensive testing status overview. Primarily for Go projects. Activates after implementing/modifying code to verify correctness, or when explicitly requested to assess test suite health.
fubira/claude-code-settings
knowledge-manager
Manages a structured knowledge base of patterns, troubleshooting guides, best practices, and workflows. Activates when discovering reusable insights, solving technical problems, or establishing new standards. Records knowledge in categorized files for future reference without bloating global CLAUDE.md.
fubira/claude-code-settings
release-assistant
Automates and ensures reliable release workflows with automatic version bump based on commit history, mandatory lint/build/test execution before release, and safe tag creation and push.
Didn't find tool you were looking for?