ReddRadar
Agent skill
Documentation Rules
All documentation in English. Root README concise, detailed docs in `/docs`.
Install this agent skill to your Project
npx add-skill https://github.com/hivellm/rulebook/tree/main/templates/skills/core/documentation-rules
SKILL.md
Documentation Standards
CRITICAL: All documentation in English. Root README concise, detailed docs in /docs.
Structure
Root-Level (ONLY):
README.md- Overview + quick startCHANGELOG.md- Version historyAGENTS.md- AI instructionsLICENSE,CONTRIBUTING.md,SECURITY.md
All Other Docs in /docs:
ARCHITECTURE.md,DEVELOPMENT.md,ROADMAP.mdspecs/,guides/,diagrams/,benchmarks/
Update Requirements by Commit Type
| Type | Update |
|---|---|
feat |
README features, API docs, CHANGELOG "Added" |
fix |
Troubleshooting, CHANGELOG "Fixed" |
breaking |
CHANGELOG + migration guide, version docs |
perf |
Benchmarks, CHANGELOG "Performance" |
security |
SECURITY.md, CHANGELOG "Security" |
docs |
Verify spelling/links only |
refactor |
Update if behavior changed |
Quality Checks (CI/CD)
markdownlint **/*.md # Lint markdown
markdown-link-check **/*.md # Check links
codespell **/*.md # Spell check
MUST pass before commit (see AGENT_AUTOMATION).
Recommended Agent Skills
Expand your agent's capabilities with these related and highly-rated skills.
hivellm/rulebook
DAG Workflow
Maintain a clean dependency graph (DAG) to prevent circular dependencies and ensure maintainable architecture.
hivellm/rulebook
Quality Enforcement
These rules are NON-NEGOTIABLE and MUST be followed without exception.
hivellm/rulebook
Rulebook Task Management
Spec-driven task management for features and breaking changes with OpenSpec-compatible format
hivellm/rulebook
Agent Automation
Mandatory workflow that AI agents MUST execute after EVERY implementation.
hivellm/rulebook
C
Execute these commands after EVERY implementation (see AGENT_AUTOMATION module for full workflow).
hivellm/rulebook
Objective-C
Execute these commands after EVERY implementation (see AGENT_AUTOMATION module for full workflow).
Didn't find tool you were looking for?