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

documentation-verification

/documentation-verification

Waliduje dokumentację przed scaleniem, sprawdzając kompletność, zepsute linki, dokładność przykładów kodu i poprawność faktograficzną w bramkach jakości.

Repozytorium
agent-skills ↗
Licencja
MIT
Ostatnia zmiana repozytorium
19.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
5
Skrypty
1
Komentarze HTML
4
Adresy URL w SKILL.md
0
Przestarzałość

Brak sygnałów. Repozytorium zmienione 19.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 sprawdzić przed instalacją
  • 1 skrypt w paczce. Przejrzyj je przed instalacją, bo Claude może je uruchomić.
  • SKILL.md zawiera komentarze HTML (4). Nie widać ich w podglądzie Markdown, a model je czyta.

Skrypty: scripts/doc-link-check.py

Co robi i kiedy

Waliduje dokumentację przed scaleniem, sprawdzając kompletność, zepsute linki, dokładność przykładów kodu i poprawność faktograficzną w bramkach jakości.

Oryginalny opis (EN)

Validate documentation before merging - check completeness, broken links, code example accuracy, and factual correctness. Use when reviewing docs for quality gates or running pre-merge doc validation.

Jak działa

  1. Activation Conditions
  2. Verification Workflow
  3. Documentation Stack Reference
  4. Cross-Client Portability
  5. MCP Availability And Fallback
  6. Anti-Patterns
  7. Verification Protocol
  8. Review Checklist
  9. References & Resources
  10. Related Skills
Sekcje z nagłówków SKILL.md, w oryginale · 91 linii, 589 słów
Podgląd SKILL.md
---
name: documentation-verification
version: "2.0"
last_updated: 2026-09-08
tags: [documentation, verification, docs, writing, quality]
description: "Validate documentation before merging - check completeness, broken links, code example accuracy, and factual correctness. Use when reviewing docs for quality gates or running pre-merge doc validation."
---
# Documentation Verification

Use this skill when a docs change needs evidence, not just a writing pass.

- Leverage native parallel subagent dispatch and 200k+ context windows where available.


## Activation Conditions

Use symptom -> action triggers: when one matches, apply this skill and verify with the protocol below.

- Reviewing docs before merge or release
- Checking README, setup, or config accuracy
- Verifying local links, commands, and code samples
- Confirming docs changed alongside user-facing behavior

## Verification Workflow

1. Confirm the docs cover the changed behavior.
2. Check relative links and referenced files.
3. Validate commands and snippets where feasible.
4. Report missing coverage and stale claims explicitly.

## Documentation Stack Reference

Inherit the shared stack from [documentation-patterns](../documentation-patterns/SKILL.md#shared-documentation-stack): source-of-truth discovery, audience framing, structure selection, verification, and freshness checks. Keep this skill focused on final evidence checks instead of restating the full stack.

<!-- MCP:START -->

<!-- PORTABILITY:START -->
## Cross-Client Portability

This skill is written to stay usable across GitHub Copilot, Claude Code, and Codex.

- GitHub Copilot: keep the folder in a Copilot-visible skill path or wrap the
  workflow in project instructions when folder discovery is unavailable.
- Claude Code: keep the folder in a local skills directory or a compatible plugin source.
- Codex: install or sync the folder into
  `$CODEX_HOME/skills/documentation-verification` and restart Codex after major changes.

<!-- PORTABILITY:END -->

## MCP Availability And Fallback

Preferred MCP Server: None required

- Fallback prompt: "Use the Documentation Verification skill without MCP. Rely on its local instructions, bundled resources, standard shell or editor tools, and direct verification. Show the evidence used before concluding."
- Do not claim an MCP operation was used when the active host does not expose it.
- Treat local files, tests, rendered outputs, logs, or screenshots as the fallback evidence path.

<!-- MCP:END -->

## Anti-Patterns

- Writing for the author instead of the reader: It bakes in unstated context and leaves the actual audience unsure what to do next.
- Skipping concrete examples or commands: Abstract guidance is easy to approve and hard to apply correctly.
- Letting links, screenshots, or versions drift: Polished formatting does not help if the instructions are no longer true.

## Verification Protocol

Before claiming "skill applied successfully":

1. Pass/fail: The Documentation Verification output identifies audience, purpose, source of truth, and freshness requirements.
2. Pass/fail: Shared documentation-stack guidance is referenced instead of duplicating another documentation skill.
3. Pass/fail: Claims, links, commands, examples, and screenshots are verified or explicitly marked unverified.
4. Pressure-test scenario: Apply the skill to a doc request with a stale command, missing owner, and conflicting audience.
5. Success metric: Zero undocumented assumptions; every reader-facing claim is sourced or scoped.

## Review Checklist

- [ ] Public behavior changes are documented
- [ ] Local links resolve
- [ ] Examples and commands still make sense
- [ ] Setup steps reflect current tool versions
- [ ] README and CHANGELOG were updated when required

## References & Resources

### Documentation
- [Validation Procedures](./references/validation.md) - Practical checks for links, examples, config, and coverage

### Scripts
- [Doc Link Check](./scripts/doc-link-check.py) - Validate relative Markdown links across one file or an entire docs tree

## Related Skills

- [documentation-authoring](../documentation-authoring/SKILL.md): Use it when the workflow also needs drafting structured technical or product documents.
- [documentation-patterns](../documentation-patterns/SKILL.md): Use it when the workflow also needs reusable documentation structures and templates.
- [documentation-quality](../documentation-quality/SKILL.md): Use it when the workflow also needs documentation review standards and quality gates.
- [notion-docs](../notion-docs/SKILL.md): Use it when the workflow also needs Notion page and database publishing workflows.
Pliki w paczce (5)
  • CHANGELOG.md 7 KB
  • LICENSE.txt 1 KB
  • SKILL.md 5 KB
  • references/validation.md 2 KB
  • scripts/doc-link-check.py 2 KB

Wersje

W bazie nie ma innych skilli o nazwie documentation-verification.

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

  • 100audit
    Audytuje kompletność dokumentacji pakietów, wykrywa rozjazd między kodem a dokumentacją i pilnuje jakości docs w monorepo.
  • 100documentation-validation
    Waliduje jakość dokumentacji: linting prozy z Vale, składnia Markdown i RST, sprawdzanie linków, testy przykładów kodu, walidacja notebooków i instrukcji instalacji oraz CI dla testów dokumentacji.
  • 100doc-drift-detector
    Wykrywa rozjazd dokumentacji z kodem, ocenia nieaktualność, waliduje dokumentację API przez parsowanie AST i sprawdza spójność linków, także w bramkach CI.
  • 90review-documentation
    Przegląda poprawność i jakość pisania dokumentacji w diffie lub na całym repozytorium.
  • 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.
  • 98review-docs
    Sprawdza dokumentację agentów pod kątem zgodności z kodem i aktualnych źródeł, wyszukuje nieaktualne twierdzenia i zepsute odnośniki.

Uwagi i zgłoszenia

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