Przejdź do treści
Biblioteka skilli
Programowanie · Automatyzacja

docs-updater

/docs-updater

Wykrywa dokumenty, które rozjechały się z kodem, i poprawia je po zmianach; w rozmowie domyślnie tylko pokazuje kandydatów.

Licencja
Apache-2.0
Ostatnia zmiana repozytorium
13.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
49
Skrypty
10
Komentarze HTML
0
Adresy URL w SKILL.md
0
Przestarzałość

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

Licencja

Apache-2.0, otwarta: można używać i zmieniać, z zachowaniem licencji i informacji o zmianach.

Co sprawdzić przed instalacją
  • 10 skryptów w paczce. Przejrzyj je przed instalacją, bo Claude może je uruchomić.

Skrypty: scripts/detect_changes.sh, scripts/lib/all.sh, scripts/lib/aws.sh, scripts/lib/common.sh, scripts/lib/csv.sh, scripts/lib/json.sh, scripts/lib/repo_paths.sh, scripts/lib/terraform.sh, scripts/lib/validation.sh, scripts/lib/yaml_map_order.py

Co robi i kiedy

Wykrywa dokumenty, które rozjechały się z kodem, i poprawia je po zmianach; w rozmowie domyślnie tylko pokazuje kandydatów.

Oryginalny opis (EN)

Detect documentation drift and patch affected docs (candidate survey, git hook, range cursor, or detect JSON). Use in conversation when the user asks to sync or update docs after code changes. Also the loop entry skill for documentation drift automation. Interactive default is survey only; edit docs when the request asks for changes to be made (for example fix, apply, or update) or automation sets agent_edit_allowed in Constraints. Not for new document creation or markdown linting.

Jak działa

  1. Input
  2. Output Specification
  3. Execution Scope
  4. Reference Files Guide
  5. Workflow
Sekcje z nagłówków SKILL.md, w oryginale · 91 linii, 835 słów
Podgląd SKILL.md
---
name: docs-updater
description: >-
  Detect documentation drift and patch affected docs (candidate survey, git
  hook, range cursor, or detect JSON). Use in conversation when the user asks
  to sync or update docs after code changes. Also the loop entry skill for
  documentation drift automation. Interactive default is survey only; edit
  docs when the request asks for changes to be made (for example fix, apply,
  or update) or automation sets agent_edit_allowed in Constraints. Not for new
  document creation or markdown linting.
license: Apache-2.0
metadata:
  author: y-miyazaki
  version: "3.4.3"
---

**UTILITY SKILL** — automated diff-sync and drift repair, not content authoring.

## Input

- **Interactive / hook (required):** resolve scope per [category-detect-scope.md](references/category-detect-scope.md) — Interactive free-form → `all` (full candidate docs); git hook → `staged`; automation cursor → `range` with `--since` — triage per [common-impact-map.md](references/common-impact-map.md); validate patches per [common-checklist.md](references/common-checklist.md)
- **Automation (optional):** detect JSON in prompt — from a caller or optional skill detect script; not required for interactive runs. Read `agent_edit_allowed` and `agent_edit_target` from `## Constraints` per [category-automation-envelope.md](references/category-automation-envelope.md); load [category-input-schema.md](references/category-input-schema.md) on that path only

Path allowlist, when present, arrives in `## Constraints`.

## Output Specification

Report per [common-output-format.md](references/common-output-format.md). On the automation path, also follow [common-output-format-automation.md](references/common-output-format-automation.md) and [category-automation-envelope.md](references/category-automation-envelope.md). Stay within [category-scope.md](references/category-scope.md).

## Execution Scope

Target: candidate documentation per [common-impact-map.md](references/common-impact-map.md) Search Scope — typically root `*.md`, the repository's documentation tree, nested `README.md` files (excluding generated directories), and site nav config when present.

### USE FOR:

- Survey candidate documentation for drift and sync opportunities (Interactive `all`); update cross-references, tables, lists, and nav entries for changed paths
- Remove dead links; update paths for renames
- Apply minimal documentation patches per [common-checklist.md](references/common-checklist.md) and [category-documentation-maintenance.md](references/category-documentation-maintenance.md)

### DO NOT USE FOR:

- New document creation or content improvement
- Non-documentation file edits
- Markdown linting
- Run detection scripts for other skills or manage caller state

## Reference Files Guide

- [common-checklist.md](references/common-checklist.md) (always read)
- [common-output-format.md](references/common-output-format.md) (always read)
- [common-impact-map.md](references/common-impact-map.md) (read on interactive path)
- [category-documentation-maintenance.md](references/category-documentation-maintenance.md) (read when deduplication or same-change sync applies)
- [category-scope.md](references/category-scope.md) (always read)
- [category-detect-scope.md](references/category-detect-scope.md) (read on interactive path)
- [category-input-schema.md](references/category-input-schema.md) (read when detect JSON is present or the optional detect script is run)
- [category-automation-envelope.md](references/category-automation-envelope.md) (read on automation path)
- [common-output-format-automation.md](references/common-output-format-automation.md) (read on automation path)
- [common-troubleshooting.md](references/common-troubleshooting.md) (read on failure)
- [category-pr-body-links.md](references/category-pr-body-links.md) (read when synthesizing the PR body)
- `assets/pr-body-template.md` and `assets/pr-body-template-survey.md` (read when synthesizing the PR body)

## Workflow

Resolve **agent_edit_allowed** before patching (git hook runs follow the Interactive rows):

| Source                                                                                                          | `agent_edit_allowed`                                                                                                                         |
| --------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- |
| Interactive — default: the request asks to look, check, triage, or survey, or only names the skill              | `false` — survey only; do not edit documentation files                                                                                       |
| Interactive — the request asks for changes to be made (for example fix, apply, 修正して, 適用して, update, add) | `true`                                                                                                                                       |
| Interactive — follow-up after a survey asking to apply                                                          | `true`                                                                                                                                       |
| Automation — `## Constraints`                                                                                   | `agent_edit_allowed: true` or `agent_edit_allowed: false` from [category-automation-envelope.md](references/category-automation-envelope.md) |

When intent is unclear, survey and offer to apply — edits are harder to undo than a report.

When `agent_edit_allowed` is `true`, resolve `agent_edit_target`: on the **interactive** path use `fix` (this skill); on the **automation** path read `agent_edit_target` from `## Constraints`. Do not branch on other caller metadata outside `## Constraints`.

### Interactive / hook path

1. Resolve scope ([category-scope.md](references/category-scope.md)). Parse detect JSON when present; otherwise resolve the detect universe from the prompt ([category-detect-scope.md](references/category-detect-scope.md)), run this skill's optional detect script with the resolved `--scope` (default `all` for Interactive free-form; `staged` for git hook; `range` when the user named a SHA range), then Agent-complement beyond mechanical output; if tools for detect are unavailable, gather changed paths from git and the user request instead of silent no-op. On detect script non-zero exit, read stdout and stop.
2. IF detect reports `skip` OR no documentation impact after gathering → emit survey no-op per [common-output-format.md](references/common-output-format.md) (Overview explains no-op); stop.
3. Triage affected docs per [common-impact-map.md](references/common-impact-map.md); grep before full read.
4. IF `agent_edit_allowed` is `false` OR `agent_edit_target` is not `fix` → emit survey shape per [common-output-format.md](references/common-output-format.md); stop — do not edit documentation files or run `git add`.
5. ELSE → apply minimal patches per [common-checklist.md](references/common-checklist.md); when the repository maintains a generated documentation index and documentation files were created/deleted/renamed, regenerate it per UV-05; stage with `git add`; emit apply shape per [common-output-format.md](references/common-output-format.md).

### Automation path

When detect JSON and `## Constraints` are present: follow [category-automation-envelope.md](references/category-automation-envelope.md) for edit gate, report shape, and synthesis. Triage and patch per [common-checklist.md](references/common-checklist.md) and [category-documentation-maintenance.md](references/category-documentation-maintenance.md). Do not manage caller state.

### Error Handling

| Condition                                                           | Severity    | Action                                                                                        |
| ------------------------------------------------------------------- | ----------- | --------------------------------------------------------------------------------------------- |
| Detect script non-zero exit or `status: "error"` (when invoked)     | Fatal       | Read stdout; stop — do not treat as success-path detect JSON                                  |
| No git repository                                                   | Fatal       | Stop                                                                                          |
| Empty diff / no documentation impact                                | Info        | Emit survey no-op (Overview explains no-op); stop                                             |
| Affected doc file missing                                           | Recoverable | Skip file; note in report                                                                     |
| Exceeds scope (>3 H2, new top-level document, etc.)                 | Recoverable | Stop for file; note out of scope for new top-level authoring                                  |
| `mkdocs.yml` missing                                                | Recoverable | Skip nav update                                                                               |
| Edit requested but `## Constraints` set `agent_edit_allowed: false` | Info        | Survey only; note that the caller Constraints disallow edits                                  |
| Automation `agent_edit_target` mismatch                             | Recoverable | Survey only per [category-automation-envelope.md](references/category-automation-envelope.md) |

### Examples

- Prompt: `Sync docs after the latest commit diff`
- Result: Survey or apply report per [references/common-output-format.md](references/common-output-format.md); stay within the UV-04 scope gate in [references/common-checklist.md](references/common-checklist.md).
Pliki w paczce (49)
  • SKILL.md 10 KB
  • eval.yaml 1 KB
  • assets/pr-body-template-survey.md 1 KB
  • assets/pr-body-template.md 2 KB
  • evals/evals.json 3 KB
  • evals/files/README.stale.md 1 KB
  • evals/files/detect-hook-staged.json 1 KB
  • evals/tasks/docs-updater-agent-edit-allowed-false.yaml 1 KB
  • evals/tasks/docs-updater-automation-boundary.yaml 1 KB
  • evals/tasks/docs-updater-automation-classification.yaml 1 KB
  • evals/tasks/docs-updater-automation-denylist.yaml 1 KB
  • evals/tasks/docs-updater-automation-dist01-negative.yaml 1 KB
  • evals/tasks/docs-updater-automation-fixture.yaml 1 KB
  • evals/tasks/docs-updater-automation-noaction.yaml 1 KB
  • evals/tasks/docs-updater-automation-production-constraints.yaml 1 KB
  • evals/tasks/docs-updater-automation-triage-contract.yaml 1 KB
  • evals/tasks/docs-updater-automation-trigger-negative.yaml 1 KB
  • evals/tasks/docs-updater-basic.yaml 1 KB
  • evals/tasks/docs-updater-deletion-deadlink.yaml 1 KB
  • evals/tasks/docs-updater-exceeded-scope.yaml 1 KB
  • evals/tasks/docs-updater-hook-detect.yaml 2 KB
  • evals/tasks/docs-updater-interactive-bare-fix-applies.yaml 1 KB
  • evals/tasks/docs-updater-interactive-fix-follow-up.yaml 1 KB
  • evals/tasks/docs-updater-interactive-fix-same-turn.yaml 1 KB
  • evals/tasks/docs-updater-interactive-survey-default.yaml 1 KB
  • evals/tasks/docs-updater-rename-detection.yaml 1 KB
  • evals/tasks/docs-updater-skip.yaml 1 KB
  • evals/tasks/docs-updater-trigger-negative.yaml 1 KB
  • references/category-automation-envelope.md 4 KB
  • references/category-detect-scope.md 2 KB
  • references/category-documentation-maintenance.md 2 KB
  • references/category-input-schema.md 3 KB
  • references/category-pr-body-links.md 1 KB
  • references/category-scope.md 2 KB
  • references/common-checklist.md 4 KB
  • references/common-impact-map.md 3 KB
  • references/common-output-format-automation.md 4 KB
  • references/common-output-format.md 2 KB
  • references/common-troubleshooting.md 1 KB
  • scripts/detect_changes.sh 19 KB
  • scripts/lib/all.sh 1 KB
  • scripts/lib/aws.sh 31 KB
  • scripts/lib/common.sh 9 KB
  • scripts/lib/csv.sh 4 KB
  • scripts/lib/json.sh 8 KB
  • scripts/lib/repo_paths.sh 16 KB
  • scripts/lib/terraform.sh 13 KB
  • scripts/lib/validation.sh 14 KB
  • scripts/lib/yaml_map_order.py 8 KB

Wersje

RepozytoriumWynikLicencja
Ta strona · y-miyazaki/terraform-aws-base100Apache-2.0
y-miyazaki/terraform-aws-base100Apache-2.0
giuseppe-trisciuoglio/developer-kit100MIT

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

Pobrania w ostatnich 30 dniach: 1 · ranking

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

Podobne skille

  • 100changelog
    Sprawdza niewydane zmiany i nieudokumentowane wydania, a w razie prośby aktualizuje CHANGELOG.md.
  • 100changelog
    Przegląda CHANGELOG.md na tle niewydanych commitów i nieudokumentowanych wydań oraz aktualizuje go na prośbę lub gdy automatyzacja na to zezwala.
  • 91update-docs
    Sprawdza dokumentację pod kątem zgodności z kodem: wykrywa nieaktualne odwołania, przestarzałe elementy i niespójności po większych zmianach.
  • 100docs-sync
    Aktualizuje dokumentację po zmianach kodu lub konfiguracji i audytuje rozjazdy, zmieniając tylko dotknięte dokumenty oraz weryfikując przykłady, linki, kontrakty i kroki operacyjne ze źródłem.
  • 100docs-update
    Synchronizuje dokumentację ze zmianami w kodzie, gdy dokumenty się rozjechały i użytkownik prosi o ich aktualizację.
  • 90oma-docs
    Sprawdza odwołania w dokumentacji, synchronizuje dokumenty ze zmianami w kodzie i wykrywa rozjazdy tłumaczeń w repozytorium.

Uwagi i zgłoszenia

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