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

oma-docs

/oma-docs

Sprawdza odwołania w dokumentacji, synchronizuje dokumenty ze zmianami w kodzie i wykrywa rozjazdy tłumaczeń w repozytorium.

Repozytorium
oh-my-agent ↗
Licencja
MIT
Ostatnia zmiana repozytorium
13.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
10
Skrypty
0
Komentarze HTML
0
Adresy URL w SKILL.md
0
Przestarzałość

Brak sygnałów. Repozytorium zmienione 13.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 robi i kiedy

Sprawdza odwołania w dokumentacji, synchronizuje dokumenty ze zmianami w kodzie i wykrywa rozjazdy tłumaczeń w repozytorium.

Oryginalny opis (EN)

Check documentation references, sync docs to code changes, and detect translation drift. Use for documentation maintenance in a repository.

Jak działa

  1. Scheduling
  2. Structural Flow
  3. Logical Operations
  4. References
Sekcje z nagłówków SKILL.md, w oryginale · 72 linii, 711 słów
Podgląd SKILL.md
---
name: oma-docs
description: Check documentation references, sync docs to code changes, and
  detect translation drift. Use for documentation maintenance in a repository.
---

# Documentation Maintenance

## Scheduling

### Goal
Keep documentation aligned with repository behavior and report verification limits.

### Intent signature
Check references, update docs for a code diff, identify translation drift, or lint localized prose.

### When to use
Repository documentation verification, diff-based synchronization, and translation maintenance.

### When NOT to use
- General source research -> oma-search.
- Application implementation -> the owning specialist.
- Translating known text -> oma-translation.

### Expected inputs
Mode (`verify`, `sync`, `i18n`, or `lint`), target paths or diff range, and authorized edit scope. Use `verify` when no mode is specified.

### Expected outputs
Findings with paths and evidence, authorized patches when requested, and unresolved checks. CLI reports remain distinct from host-authored interpretation.

### Dependencies
The `oma docs` CLI, Git for diff-based work, and repository docs. `lychee` is optional for URL verification. Read `resources/commands.md` for flags and output files of the selected mode.

## Structural Flow

### Transitions
- `verify`: extract and resolve references, then summarize the report.
- `sync`: obtain candidates, read relevant docs and diffs, and apply only authorized corrections.
- `i18n` / `lint`: report drift or style issues; use oma-translation for authorized corrections.
- Review-only requests produce proposals. Existing scoped edit requests authorize applying those corrections without another per-file approval.

### Failure and recovery
| Failure | Recovery |
|---|---|
| Missing CLI | State up front that the automated check is unavailable, then inspect manually anyway: list the target markdown files, extract `[text](path)`, `![alt](path)`, and `href`/`src` targets, resolve each relative to its containing file, and report which resolved paths are missing. Skip http(s) URLs and note them as unverified scope. Label the result "manual inspection — `oma docs verify` did not run"; never present it as CLI output and never make installing the CLI a prerequisite |
| Missing lychee or incomplete URL scan | Report core results and the unverified URL scope |
| One document cannot be parsed | Record the skipped file and continue other documents |
| Patch does not apply | Re-read the affected current content and make the equivalent authorized correction |
| Index write fails | Report the failure; do not claim the index or check is complete |

### Exit
Report verified findings, edits made, and remaining gaps. A clean reference scan does not establish semantic correctness or complete translation quality.

## Logical Operations

### Canonical command path
1. Select mode, paths/diff, and authorization from the request. Read only the matching section of `resources/commands.md`.
2. Run `oma docs verify --json`, `oma docs sync <range> --json`, `oma docs i18n --json`, or `oma docs lint --json` as appropriate. For sync, use the requested range; otherwise staged changes, then `HEAD~1..HEAD`.
3. Inspect the structured results. Verify each proposed correction against current code and document context. Exclude secret-bearing files and values from patches and reports.
4. Apply corrections already authorized by the user or assigned task. In an active OMA docs-sync workflow, first record each patch's actual apply/skip action, rationale, and evidence with `docs.sync-patch-approval`; bind `instanceId` and verification `--instance` to the doc path plus current patch revision (workflow Step 4 owns the command template). Existing authorization remains sufficient. Ask only about material missing decisions or new scope; continue independent work while waiting.
5. Re-run affected checks after edits and record remaining failures. Regenerate the reference index once after a patch batch when needed.

### Resource scope and effects
Verification regenerates `docs/generated/doc-refs.json`; optional URL results go to `docs/generated/url-drift.json`. Sync's CLI emits candidate data; the host drafts and applies patches. i18n/lint commands report only. A workflow hook runs only when `docs.auto_verify` is enabled and is warn-only.

### Guardrails
- Follow `references/_shared/core/execution-policy.md` for authorization and completion.
- Keep review-only requests read-only and changes within the assigned diff or acceptance criteria.
- Do not expose secret-bearing files (`.env*`, private keys, credentials) in diff reports.
- The CLI produces structured data; the host performs natural-language synthesis. Do not invent CLI findings or call a vendor LLM API from the docs CLI.
- Honor ignore blocks, `oma-docs: skip`, and configured exclusions. Missing gitignored runtime outputs are skipped, not broken references.
- Preserve language, terminology, and placeholders when applying localized corrections.

## References
- Mode commands, flags, and outputs: `resources/commands.md` (selected operation only).
- Translation: `../oma-translation/SKILL.md` (localized correction).
- Authorization: `references/_shared/core/execution-policy.md` (when not already provided).
Pliki w paczce (10)
  • SKILL.md 5 KB
  • references/_shared/conditional/experiment-ledger.md 2 KB
  • references/_shared/conditional/quality-score.md 3 KB
  • references/_shared/core/clarification-protocol.md 2 KB
  • references/_shared/core/execution-policy.md 5 KB
  • references/_shared/core/lessons-learned.md 3 KB
  • references/_shared/core/session-metrics.md 4 KB
  • references/_shared/runtime/memory-protocol.md 5 KB
  • references/_shared/runtime/result-contract.md 10 KB
  • resources/commands.md 3 KB

Wersje

RepozytoriumWynikLicencja
Ta strona · first-fluke/oh-my-agent90MIT
first-fluke/oh-my-agent90MIT

Migawka bazy z 13.11.2026 · wersja paczki f451ee7a9813 (skrót SHA-256 całej paczki)

Pobrania w ostatnich 30 dniach: 1 · ranking

Zgłoś problem z tym skillem: szkodliwa treść, błędny opis albo prośba autora o usunięcie.

Podobne skille

  • 100plan-docs-sync
    Planuje audyt dokumentacji względem faktycznego działania kodu: wykrywa rozjazdy, nieaktualne README i dokumentację onboardingową opisującą nieistniejące elementy.
  • 90check-docs
    Sprawdza, czy README, AGENTS.md i katalog docs są zgodne z ostatnimi zmianami w kodzie.
  • 100docs-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.
  • 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.
  • 91update-docs
    Sprawdza dokumentację pod kątem zgodności z kodem: wykrywa nieaktualne odwołania, przestarzałe elementy i niespójności po większych zmianach.
  • 100update-docs
    Wykrywa rozjazdy między dokumentacją a kodem, oznacza nieaktualne twierdzenia i wprowadza poprawki w dokumentach.

Uwagi i zgłoszenia

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