Przejdź do treści
Biblioteka skilli
Programowanie · Przegląd i audyt

docs-maintenance

/docs-maintenance

Chroni dokumentację przed starzeniem przez wykrywanie nieaktualności, przypisanie właścicieli, testy dokumentów i świadome wycofywanie treści, gdy dokumenty rozjechały się z rzeczywistością.

Repozytorium
AI-SKILLS ↗
Licencja
MIT
Ostatnia zmiana repozytorium
05.09.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
0
Adresy URL w SKILL.md
0
Przestarzałość

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

Licencja

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

Co robi i kiedy

Chroni dokumentację przed starzeniem przez wykrywanie nieaktualności, przypisanie właścicieli, testy dokumentów i świadome wycofywanie treści, gdy dokumenty rozjechały się z rzeczywistością.

Oryginalny opis (EN)

Keep documentation from rotting through staleness detection, ownership, doc tests, and deliberate deprecation. Use when docs have drifted from reality or no process keeps them current.

Jak działa

  1. Method
  2. Boundaries
Sekcje z nagłówków SKILL.md, w oryginale · 71 linii, 477 słów
Podgląd SKILL.md
---
name: docs-maintenance
description: Keep documentation from rotting through staleness detection, ownership, doc tests, and deliberate deprecation. Use when docs have drifted from reality or no process keeps them current.
---

# Docs maintenance

Documentation decays the moment it is written, because the code keeps
moving and the docs do not. Stale docs are worse than missing docs:
they mislead confidently, and readers trust them until burned.
Maintenance is the process that keeps docs true, and it must be
systematic because good intentions do not survive a busy quarter.

## Method

1. **Test what can be tested.** Code examples run in CI (see
   docs-as-code, tutorial-writing), links checked, generated
   reference regenerated on every build (see
   api-reference-docs): so the mechanically-verifiable parts
   of docs break the build when they drift, not the reader's
   afternoon three months later. This catches the
   highest-impact staleness automatically.
2. **Change docs with the code that invalidates them.** The
   PR that changes behavior updates the affected docs (see
   docs-as-code): this is the single most effective
   maintenance practice, because it fixes drift at the
   moment it would occur, by the person who knows what
   changed, while it is fresh (see pull-request-size's
   same-PR discipline).
3. **Assign ownership.** Every doc (or doc area) has an
   owner accountable for its accuracy (see code-owners):
   ownerless docs are nobody's job and rot fastest. The
   owner is not the sole author but the person who ensures
   it stays true, reviews changes to the code it describes,
   and answers "is this still right".
4. **Detect staleness actively.** Signals: docs referencing
   removed features or old commands, last-updated dates far
   behind the code's, support questions revealing a gap or
   error, analytics showing high-traffic pages (worth
   maintaining) vs dead ones (candidates to cut). A periodic
   review pass (quarterly) against these signals catches
   what automated tests cannot (see the drift-monitoring
   ethic, applied to docs).
5. **Deprecate and delete deliberately.** Docs for removed
   features get removed (see feature-sunsetting's honesty);
   superseded guides get a redirect or a clear "outdated,
   see X"; the docs graveyard of half-true old pages is its
   own information-architecture problem (see
   docs-information-architecture). Deleting stale docs is
   maintenance, not loss: a wrong page removed is a reader
   un-misled.
6. **Make maintenance low-friction and shared.** If fixing a
   doc is a one-line PR with a preview (see docs-as-code),
   the whole team fixes what they notice (see
   boy-scout-rule); if it requires a separate CMS and
   process, only the docs silo touches it and drift wins.
   Low friction plus shared ownership is what makes
   maintenance actually happen.

## Boundaries

- Not all docs deserve equal maintenance; high-traffic,
  high-stakes docs (getting-started, API reference,
  security: see api-reference-docs) get rigorous upkeep,
  low-traffic internal notes get less. Spend maintenance
  where readers and consequences are.
- Automated checks catch mechanical drift (broken examples,
  dead links) but not semantic drift (prose that is subtly
  wrong now): human review and the same-PR discipline
  remain necessary (the same limit as data-quality-checks
  vs semantic correctness).
- A maintenance process cannot rescue docs with no owner
  and no co-location; docs-as-code and ownership (steps
  2-3) are the prerequisites that make the rest possible.

Wersje

W bazie nie ma innych skilli o nazwie docs-maintenance.

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

  • 100docs-update
    Synchronizuje dokumentację ze zmianami w kodzie, gdy dokumenty się rozjechały i użytkownik prosi o ich aktualizację.
  • 90doc-updater
    Synchronizuje dokumentację, README, notatki wydania i dokumenty operacyjne, które rozjechały się z aktualnym działaniem wydanego produktu.
  • 90doc-updater
    Synchronizuje dokumentację, README, notatki wydania i dokumenty operacyjne, które rozjechały się z aktualnym działaniem wydanego produktu.
  • 100docs-as-code
    Traktuje dokumentację jak kod: trzyma ją w repozytorium, przegląda w pull requestach, sprawdza w CI i buduje podglądy, gdy dokumentacja rozjeżdża się z rzeczywistością.
  • 100doc-maintenance
    Utrzymuje dokumentację repozytorium krótką i prawdziwą: dokumenty są mapą do kodu, każde twierdzenie ma kotwicę w pliku, teście lub skrypcie, a treść do wyczytania ze źródła w minutę jest usuwana.
  • 100audit-docs
    Audytuje dokumentację pod kątem dryfu, nieaktualności i niespójności względem faktycznego kodu, uruchamiając równoległe subagenty do przeglądu podsystemów.

Uwagi i zgłoszenia

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