document
/document
Bring the documentation of this repository up to date with the code - docstrings, README, docs/ pages, phase status, ADRs and CLAUDE.md. Use after implementing or changing something, when the user asks to "documentar", "actualiza la documentación", or before opening a PR.
- Author
- R0drig0V1 ↗
- Repository
- claude-code-herdr ↗
- Licence
- MIT
- Last repository change
- 09.11.2026
Assessment and security
- Files in this package
- 1
- Scripts
- 0
- HTML comments
- 2
- URLs in SKILL.md
- 0
No signals detected. Repository changed on 09.11.2026, without references to retired models or APIs.
MIT, open: use and modify while retaining author attribution.
- SKILL.md zawiera komentarze HTML (2). Nie widać ich w podglądzie Markdown, a model je czyta.
What it does and when to use it
Bring the documentation of this repository up to date with the code - docstrings, README, docs/ pages, phase status, ADRs and CLAUDE.md. Use after implementing or changing something, when the user asks to "documentar", "actualiza la documentación", or before opening a PR.
Triggers from the description
Original author description
Bring the documentation of this repository up to date with the code - docstrings, README, docs/ pages, phase status, ADRs and CLAUDE.md. Use after implementing or changing something, when the user asks to "documentar", "actualiza la documentación", or before opening a PR.
How it works
- 1. Find what changed
- 2. Update, in this order
- Map: code → docs
- 3. Verify
SKILL.md preview
---
name: document
description: Bring the documentation of this repository up to date with the code - docstrings, README, docs/ pages, phase status, ADRs and CLAUDE.md. Use after implementing or changing something, when the user asks to "documentar", "actualiza la documentación", or before opening a PR.
---
<!--
document skill of the multi-agent-herdr plugin. Unchanged from multi-agent 0.1.0's
`document` skill apart from this header.
-->
# Document
This repository must stay **extremely well documented**. Documentation is in English.
## 1. Find what changed
```bash
git status --short
git diff origin/<base>...HEAD --stat # <base>: `"${CLAUDE_PLUGIN_ROOT}/scripts/project-config.py" base_branch`; or `git diff` for uncommitted work
```
## 2. Update, in this order
1. **Docstrings and comments in the changed code.** Every module has a docstring (or header
comment) explaining its role; every public function/class has one stating behaviour,
arguments and failure modes. Comments explain *why*, not *what*. Match the density of the
surrounding code.
2. **`docs/` pages affected** (use the map below). Keep examples runnable; if a command or
output changed, re-run it and paste the real result.
3. **Phase documents** in `docs/phases/`: in a development worktree, do not edit them (the
integrator owns them); list completed and discovered tasks for the PR body instead. In the
integrator session: tick tasks, update the status line and the roadmap table in
`docs/phases/README.md`, and record deviations from the plan with a one-line reason.
4. **Decisions**: a choice that is hard to reverse or that future readers would question gets
an ADR in `docs/decisions/NNNN-title.md` (Context / Decision / Consequences) and a line in
`docs/decisions/README.md`.
5. **README.md** (root): only if setup, commands or the feature list changed.
6. **CLAUDE.md**: only if conventions, commands or architecture rules changed. Keep it short.
## Map: code → docs
<!-- TODO: fill in for this project, one row per area of the code. -->
| Change in | Update |
|-----------|--------|
| architecture, module boundaries | `docs/architecture.md` |
| setup, env vars, commands | `README.md`, `.env.example` |
| `.claude/`, `scripts/` | `CLAUDE.md` ("Multi-agent workflow", "Commands") |
## 3. Verify
- Every relative link you touched resolves (`ls` the target).
- Commands you documented actually run.
- Summarise to the user which files were updated and why.
Versions
| Repository | Score | Licence |
|---|---|---|
| This page · R0drig0V1/claude-code-herdr | 100 | MIT |
| team-blue-Hub/scripta | 100 | Apache-2.0 |
| awrshift/agent-memory-kit | 100 | MIT |
| metabase/metabase-cli | 100 | AGPL-3.0 |
| rossumai/claude-marketplace | 100 | MIT |
| zimoliao/scholaraio | 100 | MIT |
| archcore-ai/archcore | 100 | Apache-2.0 |
| hellblazer/nexus | 100 | AGPL-3.0 |
| awrshift/claude-memory-kit | 100 | MIT |
Database snapshot: 13.11.2026 · package version 03ff021fd0c9 (SHA-256 digest of the entire package)
Downloads in the last 30 days: 0 · ranking
Report a problem with this skill: harmful content, incorrect descriptions or an author’s removal request.
Similar skills
- 100documenting
Writes or updates project documentation (README, docs/, docstrings, decision log). Use when behaviour, setup, or architecture changes, or when asked to document something. - 100doc-gen
Generate documentation from source code — docstrings, READMEs, API references. Triggers on: generate docs, write documentation, document this, create README, API docs, doc-gen. - 100documentation
Generate docstrings, JSDoc, API docs, and README updates that reflect current code. Use when: docs, docstring, JSDoc, README, API docs, document this, add documentation. - 100technical-writing
Use when writing developer-facing documentation — READMEs, API references, architecture docs, ADRs, runbooks, and docstrings. Covers structure by document type, writing for the reader's task, and keeping docs accurate against the code. - 100repo
Update repository documentation (README.md, docs/, CLAUDE.md) based on session changes by dispatching the up-docs-propagate-repo sub-agent. This skill should be used when the user runs /up-docs:repo. - 100documentation
Use this skill when the user asks you to write, update, or fix project documentation — READMEs, API docs, user guides, ADRs, or other Markdown docs. Also use when code changes need user-facing docs updates. Only write Markdown files; do not use for implementation, planning or test work.