Przejdź do treści
Biblioteka skilli
Dokumenty i biuro · Pisanie

documentation-sync-recipe

/documentation-sync-recipe

Opisuje etap synchronizacji dokumentacji w pełnej zmianie: znajduje dokumenty, które zdezaktualizował kod, aktualizuje je i wskazuje, co zostaje.

Repozytorium
paqad-ai ↗
Licencja
MIT
Ostatnia zmiana repozytorium
12.11.2026

Ocena i bezpieczeństwo

90/ 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ść25 / 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
4
Skrypty
1
Komentarze HTML
0
Adresy URL w SKILL.md
0
Przestarzałość

Brak sygnałów. Repozytorium zmienione 12.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ą
  • 1 skrypt w paczce. Przejrzyj je przed instalacją, bo Claude może je uruchomić.

Skrypty: scripts/stale-docs.mjs

Co robi i kiedy

Opisuje etap synchronizacji dokumentacji w pełnej zmianie: znajduje dokumenty, które zdezaktualizował kod, aktualizuje je i wskazuje, co zostaje.

Oryginalny opis (EN)

The method for the documentation sync stage of a full-lane change: find the docs the diff made stale, update each surface, and name what stays. Use when you are the paqad documentation sync stage agent.

Jak działa

  1. What It Does
  2. Use This When
  3. Inputs
  4. Procedure
  5. Read This Path
  6. Output Contract
  7. Escalate / Stop Conditions
Sekcje z nagłówków SKILL.md, w oryginale · 36 linii, 320 słów
Podgląd SKILL.md
---
name: documentation-sync-recipe
description: 'The method for the documentation sync stage of a full-lane change: find the docs the diff made stale, update each surface, and name what stays. Use when you are the paqad documentation sync stage agent.'
metadata:
  model_tier: reasoning
  cacheable: 'false'
  output_format: markdown
  paqad-meta: skill.meta.yaml
---

## What It Does

Gives the documentation sync stage one method and a script that lists the stale docs.

## Use This When

You are the paqad stage agent for this stage. Your injected copy is the truth for this stage; the source skills it copies stay for their other workflows.

## Inputs

- The request and `review.json` from `paqad-ai stage begin documentation_sync`.
- The list of changed files.

## Procedure

1. Restate the request and its acceptance criteria in two lines at the top of your return.
2. Work quickly: skip anything this stage doesn't need, and return as soon as the result is correct.
3. Sync canonical docs affected by the feature diff after verification passes.
4. List the candidates: pipe the changed files into `node <dir>/base/skills/documentation-sync-recipe/scripts/stale-docs.mjs`, where `<dir>` is the install directory that `.paqad/framework-path.txt` names, or read them from the refusal of `stage end`.
5. Update behaviour docs, module docs and registries together, never only one surface. Prefer generated inventories for routes, events and error codes.
6. End with `paqad-ai stage end documentation_sync --agent paqad-documentation-sync`. It runs the `stale-docs.mjs` check itself and refuses while a candidate has no change. Name a doc that truly needs none with `--stale-ok <path>`, one per doc, and say why in your return.

## Read This Path

- For the full diff rules, read `base/skills/diff-doc-sync/SKILL.md` under the install directory that `.paqad/framework-path.txt` names.
- For every doc surface, read `base/skills/canonical-doc-sync/SKILL.md` under the install directory that `.paqad/framework-path.txt` names.

## Output Contract

- The updated docs, and a return that names each doc left alone and why.

## Escalate / Stop Conditions

- A doc you cannot update without a decision: run `paqad-ai decision create`, on `earlier_check` scan the titles, read up to 5 with `decision check <id> --read` and run `decision suggest`, on `"reused": true` carry on as your rules say, and unless it was reused return `paused: D-<id>`. A recipe never resolves it.
Pliki w paczce (4)
  • SKILL.md 2 KB
  • skill.meta.yaml 1 KB
  • agents/openai.yaml 1 KB
  • scripts/stale-docs.mjs 4 KB

Wersje

W bazie nie ma innych skilli o nazwie documentation-sync-recipe.

Migawka bazy z 13.11.2026 · wersja paczki 7ebe45bcacf5 (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

  • 90checks-recipe
    Opisuje etap sprawdzeń w pełnej ścieżce zmian: czyta plan, uruchamia testy projektu raz i zgłasza każdą awarię.
  • 90review-recipe
    Prowadzi etap przeglądu zmiany: czyta podsumowanie, ocenia diff względem zamrożonej specyfikacji i zapisuje uszeregowane ustalenia.
  • 90nth-doc-sync
    Sprawdza dokumentację po zmianie kodu, architektury, schematu lub API i wskazuje nieaktualne, brakujące i sprzeczne opisy.
  • 90codex-docs-change-sync
    Mapuje git diff na dokumenty, które mogą wymagać aktualizacji po zmianach kodu, bez automatycznej edycji dokumentacji.
  • 90sync-docs
    Aktualizuje istniejącą dokumentację po zmianie zakresu kodu lub zachowania, zgłaszając różnice między zamierzonym a wdrożonym działaniem.
  • 100sync-docs-site
    Aktualizuje dokumentację użytkownika w docs-site na podstawie wydania: CHANGELOG, README i kodu, by opisy zgadzały się z funkcjami.

Uwagi i zgłoszenia

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