Przejdź do treści
Biblioteka skilli
Programowanie · Automatyzacja

code-examples-sync

/code-examples-sync

Synchronizuje i weryfikuje przykłady kodu w dokumentacji po zmianach sygnatur funkcji, interfejsów API i importów, gdy fragmenty stają się nieaktualne.

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/example-sync-check.py

Co robi i kiedy

Synchronizuje i weryfikuje przykłady kodu w dokumentacji po zmianach sygnatur funkcji, interfejsów API i importów, gdy fragmenty stają się nieaktualne.

Oryginalny opis (EN)

Synchronize and verify code examples in documentation. Use when function signatures change, API interfaces update, imports shift, or documentation snippets become outdated and need correction.

Jak działa

  1. Activation Conditions
  2. Workflow
  3. Cross-Client Portability
  4. MCP Availability And Fallback
  5. Anti-Patterns
  6. Verification Protocol
  7. Quality Checklist
  8. References & Resources
  9. Related Skills
Sekcje z nagłówków SKILL.md, w oryginale · 88 linii, 580 słów
Podgląd SKILL.md
---
name: code-examples-sync
version: "2.0"
last_updated: 2026-09-08
tags: [code, examples, sync, workflow, quality]
description: "Synchronize and verify code examples in documentation. Use when function signatures change, API interfaces update, imports shift, or documentation snippets become outdated and need correction."
---
# Code Example Synchronization

Use this skill when docs contain code snippets that are likely to drift from the real implementation.

- 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.

- Function signatures changed
- Imports or package names changed
- Request or response contracts changed
- Framework guidance or recommended patterns changed
- A doc snippet compiles conceptually but no longer matches the codebase

## Workflow

1. Find the canonical implementation first.
2. Update every affected snippet in docs, examples, and READMEs.
3. Verify syntax, imports, and expected outputs.
4. Note any intentional divergence, such as simplified tutorial snippets.

<!-- 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/code-examples-sync` and restart Codex after major changes.

<!-- PORTABILITY:END -->

## MCP Availability And Fallback

Preferred MCP Server: None required

- Fallback prompt: "Use the Code Example Synchronization 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

- Starting work before the plan or gate is clear: Execution drifts when success criteria are implied instead of explicit.
- Treating verification as optional cleanup: The last mile is where regressions and missing updates are usually hiding.
- Mixing planning, implementation, and release work in one jump: You lose the causal chain that explains why a change is safe.

## Verification Protocol

Before claiming "skill applied successfully":

1. Pass/fail: The Code Examples Sync workflow starts from explicit success criteria, constraints, and stop conditions.
2. Pass/fail: Required evidence is collected before any completion, approval, or readiness claim.
3. Pass/fail: The next action follows the documented gate order without skipping review or verification steps.
4. Pressure-test scenario: Apply the workflow under time pressure with one failing check and one tempting shortcut.
5. Success metric: Zero rationalizations; blocked, failed, or unverified work is reported as such.

## Quality Checklist

- [ ] Snippet matches current API shape
- [ ] Imports and package names are current
- [ ] Async, error handling, and setup steps still make sense
- [ ] Output examples match current behavior
- [ ] Duplicate snippets across docs were updated together

## References & Resources

### Documentation
- [Code Example Verification](./references/verification.md) - Checks for examples, imports, outputs, and compatibility

### Scripts
- [Example Sync Check](./scripts/example-sync-check.py) - Audit Markdown files for untyped fences, placeholder text, and obviously stale examples

## Related Skills

- [development-workflow](../development-workflow/SKILL.md): Use it when the workflow also needs planning, quality gates, and delivery tracking.
- [code-quality](../code-quality/SKILL.md): Use it when the workflow also needs two-stage review (spec compliance first, then code quality), maintainability, and refactoring guidance.
- [systematic-debugging](../systematic-debugging/SKILL.md): Use it when the workflow also needs root-cause debugging before proposing fixes.
- [test-driven-development](../test-driven-development/SKILL.md): Use it when the workflow also needs test-first implementation and regression safety.
Pliki w paczce (5)
  • CHANGELOG.md 6 KB
  • LICENSE.txt 1 KB
  • SKILL.md 4 KB
  • references/verification.md 1 KB
  • scripts/example-sync-check.py 2 KB

Wersje

W bazie nie ma innych skilli o nazwie code-examples-sync.

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

  • 95verify-examples
    Uruchamia przykłady z dokumentacji, np. polecenia i fragmenty kodu, i sprawdza, czy wynik zgadza się z obietnicą.
  • 100repo-website-api-update
    Aktualizuje dokumentację API Formisch po zmianach sygnatur, typów, interfejsów i komentarzy JSDoc w kodzie biblioteki.
  • 95docs-search
    Przeszukuje automatycznie wygenerowaną dokumentację kodu pod kątem sygnatur funkcji, dokumentacji API, definicji klas i komentarzy, także przed wprowadzaniem zmian.
  • 100js-docs-sync
    Utrzymuje ręcznie pisaną dokumentację w katalogu docs/ pakietów JS zgodną z kodem źródłowym, aktualizując ją po zmianie eksportów, sygnatur funkcji i typów.
  • 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.
  • 100documentation-lookup
    Wyszukuje aktualną dokumentację bibliotek, frameworków i API oraz przykłady kodu zgodne z wersją.

Uwagi i zgłoszenia

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