Przejdź do treści
Biblioteka skilli
Programowanie · Automatyzacja

docs-drift-guard

/docs-drift-guard

Ogranicza dryf dokumentacji: każdy fakt ma jedno źródło, odwołania są generowane, a przykłady i lokalne linki sprawdzają narzędzia repozytorium.

Repozytorium
dev-skills ↗
Licencja
MIT
Ostatnia zmiana repozytorium
18.10.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
1
Przestarzałość

Brak sygnałów. Repozytorium zmienione 18.10.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

Ogranicza dryf dokumentacji: każdy fakt ma jedno źródło, odwołania są generowane, a przykłady i lokalne linki sprawdzają narzędzia repozytorium.

Oryginalny opis (EN)

Reduce documentation drift by giving facts one authored home, generating mutable references, executing examples and checking local links through repository-owned tooling. Use for stale docs, broken references or documentation maintenance.

Jak działa

  1. Scope
  2. Prerequisites
  3. Procedure
  4. Completion
Sekcje z nagłówków SKILL.md, w oryginale · 46 linii, 330 słów
Podgląd SKILL.md
---
name: docs-drift-guard
description: Reduce documentation drift by giving facts one authored home, generating mutable references, executing examples and checking local links through repository-owned tooling. Use for stale docs, broken references or documentation maintenance.
---

# Documentation drift guard

## Scope

This skill owns documentation method. The repo owns protected documents, generated
outputs, check entrypoints and review requirements. A working link establishes
path integrity, not that the surrounding claim is still true.

## Prerequisites

Read AGENTS.md and the relevant doc's source/ownership rules. Identify the facts
being described, their code/configuration source and existing tests/generators.
Use [harness-operations](../harness-operations/SKILL.md) only when tool mapping is
needed. Do not introduce a new dependency merely to run this skill.

## Procedure

1. Give each fact one authored home and link other consumers to it. Keep stable
   architecture intent in prose; derive API, CLI, configuration and mutable
   inventories from their owning source when possible.
2. Prefer generated output with freshness checks, then executed examples, then
   deterministic structural checks, then explicit review of remaining prose.
   A generated artifact still needs a check against its source; generation alone
   does not guarantee freshness. Keep model-based semantic review advisory.
3. Reuse the repo's existing link/path, doctest, snippet or architecture gate.
   If a new checker is needed, add it through the repo's dependency/CI process
   with a pinned version and prove it catches a broken reference or stale sample.
4. For JavaScript repos adopting the maintained
   [docs-drift-check](https://github.com/onsager-ai/docs-drift-check) tool, use its
   locked local binary via the owning package script or `npx --no-install
   docs-drift-check`. Do not rely on an unpinned runtime download. External-link
   checks are a separate opt-in network axis, not an offline requirement.
5. Match higher checks to the claim: doctests for runnable examples; deterministic
   transclusion/freshness checks for code snippets; dependency rules for layering;
   path-triggered owner review for prose that cannot be mechanically derived.
6. Edit the canonical source and regenerate outputs. Preserve ADR history through
   the repository's amendment convention. Do not make separate hand-edited copies
   of generated docs, common prompts or native skill projections.

## Completion

Report authored source, generated consumers, checks/negative controls and their
results. State which semantic claims still depend on review and which network
checks were unrun. A file that exists can still describe obsolete behavior.

Wersje

W bazie nie ma innych skilli o nazwie docs-drift-guard.

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

  • 100doc-freshness
    Wykrywa rozjazd dokumentacji z kodem, sprzeczne informacje między dokumentami i nieaktualne odwołania, takie jak zepsute linki, usunięte pliki i stare wersje.
  • 90oma-docs
    Sprawdza odwołania w dokumentacji, synchronizuje dokumenty ze zmianami w kodzie i wykrywa rozjazdy tłumaczeń w repozytorium.
  • 90oma-docs
    Sprawdza odwołania w dokumentacji, synchronizuje ją ze zmianami w kodzie i wykrywa rozjazd między wersjami tłumaczeń w repozytorium.
  • 95docs-build-and-verify
    Buduje podgląd strony dokumentacji Flet i sprawdza martwe linki, obrazy oraz nierozwiązane odwołania reST.
  • 100docs-sync
    Audytuje i aktualizuje dokumentację użytkownika Argus względem kodu, wykrywając dryf wersji, liczby poleceń, zgodność i18n oraz nieaktualne przykłady CLI przed wydaniem.
  • 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.

Uwagi i zgłoszenia

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