Przejdź do treści
Biblioteka skilli
Programowanie · Pisanie

document

/document

Aktualizuje dokumentację repozytorium do stanu kodu: docstringi, README, strony docs, ADR i CLAUDE.md, także przed otwarciem PR.

Licencja
MIT
Ostatnia zmiana repozytorium
09.11.2026

Ocena i bezpieczeństwo

100/ 100Klasa: dobry
Format25 / 25
Frontmatter z nazwą i opisem, poprawna nazwa, opis do 1024 znaków, nazwa zgodna z folderem.
Odkrywalność25 / 25
Opis mówi, kiedy użyć skilla, ma sensowną długość i jest w 3. osobie.
Treść35 / 35
Co najmniej 150 słów i do 500 linii, nagłówki, listy kroków, przykłady albo kod.
Higiena15 / 15
Bez zaślepek typu TODO, bez ścieżek Windows, z licencją.
Ryzykobrak sygnałów w skanie
Pliki w paczce
1
Skrypty
0
Komentarze HTML
2
Adresy URL w SKILL.md
0
Przestarzałość

Brak sygnałów. Repozytorium zmienione 09.11.2026, bez odwołań do wycofanych modeli i API.

Licencja

MIT, otwarta: można używać i zmieniać, z zachowaniem informacji o autorze.

Co sprawdzić przed instalacją
  • SKILL.md zawiera komentarze HTML (2). Nie widać ich w podglądzie Markdown, a model je czyta.

Co robi i kiedy

Aktualizuje dokumentację repozytorium do stanu kodu: docstringi, README, strony docs, ADR i CLAUDE.md, także przed otwarciem PR.

Wyzwalacze z opisu

documentaractualiza la documentación
Oryginalny opis (EN)

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.

Jak działa

  1. 1. Find what changed
  2. 2. Update, in this order
  3. Map: code → docs
  4. 3. Verify
Sekcje z nagłówków SKILL.md, w oryginale · 51 linii, 317 słów
Podgląd SKILL.md
---
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.

Wersje

RepozytoriumWynikLicencja
Ta strona · R0drig0V1/claude-code-herdr100MIT
team-blue-Hub/scripta100Apache-2.0
awrshift/agent-memory-kit100MIT
metabase/metabase-cli100AGPL-3.0
rossumai/claude-marketplace100MIT
zimoliao/scholaraio100MIT
archcore-ai/archcore100Apache-2.0
hellblazer/nexus100AGPL-3.0
awrshift/claude-memory-kit100MIT

Migawka bazy z 13.11.2026 · wersja paczki 03ff021fd0c9 (skrót SHA-256 całej paczki)

Pobrania w ostatnich 30 dniach: 0 · ranking

Zgłoś problem z tym skillem: szkodliwa treść, błędny opis albo prośba autora o usunięcie.

Podobne skille

  • 100documenting
    Pisze lub aktualizuje dokumentację projektu, np. README, docs, docstringi i dziennik decyzji, gdy zmienia się zachowanie lub architektura.
  • 100doc-gen
    Generuje dokumentację z kodu źródłowego: docstringi, pliki README i referencje API.
  • 100documentation
    Generuje docstringi, JSDoc, dokumentację API i aktualizacje README, które odzwierciedlają bieżący kod.
  • 100technical-writing
    Pomaga pisać dokumentację deweloperską: README, referencje API, opisy architektury, ADR, runbooki i docstringi zgodne z kodem.
  • 100repo
    Aktualizuje dokumentację repozytorium, czyli README, docs i CLAUDE.md, na podstawie zmian z sesji.
  • 100documentation
    Pisze, aktualizuje i poprawia dokumentację projektu w Markdown: README, dokumentację API, przewodniki użytkownika i ADR, także po zmianach kodu wymagających opisu dla użytkownika.

Uwagi i zgłoszenia

Wiadomość trafi do Bartosza Sokolińskiego. Adres e-mail jest potrzebny tylko do odpowiedzi. Szczegóły w polityce prywatności.