# Documentation Rules

> All documentation in English. Root README concise, detailed docs in `/docs`. Use when this capability is needed.

- Skill: `tomevault-io/documentation-rules` (Agent Skill, multi-file: 2 files)
- Install (CLI): `npx skillmds@latest add tomevault-io/documentation-rules`
- Raw SKILL.md: https://api.skillmd.com/api/skills/tomevault-io/documentation-rules/raw
- Safety review: pending
- Works with: Claude Code, Claude.ai, OpenAI Codex
- Category: Docs & Writing
- Author: tomevault-io (https://skillmd.com/u/tomevault-io)
- Updated: 2026-09-17
- Page: https://skillmd.com/skills/tomevault-io/documentation-rules

---

# 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).

---
> Source: [hivellm/rulebook](https://github.com/hivellm/rulebook) — distributed by [TomeVault](https://tomevault.io).
<!-- tomevault:4.0:skill_md:2026-06-16 -->