Documentation Rules

All documentation in English. Root README concise, detailed docs in `/docs`.

11 stars

Best use case

Documentation Rules is best used when you need a repeatable AI agent workflow instead of a one-off prompt.

All documentation in English. Root README concise, detailed docs in `/docs`.

Teams using Documentation Rules should expect a more consistent output, faster repeated execution, less prompt rewriting.

When to use this skill

You want a reusable workflow that can be run more than once with consistent structure.

When not to use this skill

You only need a quick one-off answer and do not need a reusable workflow.
You cannot install or maintain the underlying files, dependencies, or repository context.

Installation

Claude Code / Cursor / Codex

$curl -o ~/.claude/skills/documentation-rules/SKILL.md --create-dirs "https://raw.githubusercontent.com/hivellm/rulebook/main/templates/skills/core/documentation-rules/SKILL.md"

Manual Installation

Download SKILL.md from GitHub
Place it in .claude/skills/documentation-rules/SKILL.md inside your project
Restart your AI agent — it will auto-discover the skill

How Documentation Rules Compares

Feature / Agent	Documentation Rules	Standard Approach
Platform Support	Not specified	Limited / Varies
Context Awareness	High	Baseline
Installation Complexity	Unknown	N/A

Frequently Asked Questions

What does this skill do?

All documentation in English. Root README concise, detailed docs in `/docs`.

Where can I find the source code?

You can find the source code on GitHub using the link provided at the top of the page.

SKILL.md Source

# Documentation Standards

**CRITICAL**: All documentation in English. Root README concise, detailed docs in `/docs`.

## Structure

**Root-Level (ONLY):**
- `README.md` - Overview + quick start
- `CHANGELOG.md` - Version history
- `AGENTS.md` - AI instructions
- `LICENSE`, `CONTRIBUTING.md`, `SECURITY.md`

**All Other Docs in `/docs`:**
- `ARCHITECTURE.md`, `DEVELOPMENT.md`, `ROADMAP.md`
- `specs/`, `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)

```bash
markdownlint **/*.md         # Lint markdown
markdown-link-check **/*.md  # Check links
codespell **/*.md            # Spell check
```

**MUST pass before commit** (see AGENT_AUTOMATION).

Related Skills

We are still matching the closest adjacent skills for this page. In the meantime, continue through the full directory.