oma-docs — скилл для Claude Code: что делает и как установить
Сверяет ссылки в документации, обновляет тексты под изменения в коде и находит рассинхрон в переводах. Работает через CLI oma docs или ручной парсинг ссылок.
MIT ★ 1 472 обновлён 2026-11-05
/plugin marketplace add first-fluke/oh-my-agent
/plugin install oma@oh-my-agentЧто делает oma-docs
Скилл поддерживает четыре режима: verify, sync, i18n и lint. По умолчанию запускается проверка verify, собирающая локальные пути к файлам и изображениям в отчёт docs/generated/doc-refs.json. В режиме sync агент анализирует diff в Git (диапазон коммитов или staged-изменения) и предлагает точечные правки в документации.
Для автоматической проверки требуется CLI oma docs, а для сетевых адресов — утилита lychee. Если CLI не установлен, агент не прерывает работу, а вручную разбирает синтаксис [text](path) и теги img/href в Markdown-файлах, отмечая внешние URL непроверенными.
Скилл исключает приватные данные: файлы .env*, ключи и пароли не попадают в отчёты и патчи. Разметку oma-docs: skip и правила .gitignore он учитывает автоматически, поэтому сгенерированные файлы сборки не помечаются как битые ссылки.
Какие задачи решает
- найти битые относительные ссылки и пути к картинкам в Markdown
- синхронизировать документацию с diff коммитов в Git
- выявить расхождения в переведённых версиях документов
- проверить оформление и стиль локализованных текстов
Примеры запросов агенту
- Проверь битые ссылки в документации проекта
- Синхронизируй документацию с изменениями в HEAD~1..HEAD
- Найди рассинхрон в переводах через режим i18n
Как установить oma-docs
1Через маркетплейс плагинов
/plugin marketplace add first-fluke/oh-my-agent/plugin install oma@oh-my-agentКоманда ставит плагин oma целиком, со всеми его скиллами
2Через Skills CLI (Vercel)
npx skills add first-fluke/oh-my-agent --skill oma-docs -a claude-code3Вручную: положить файлы
~/.claude/skills/oma-docs/SKILL.mdПапка скилла целиком; для одного проекта — .claude/skills/oma-docs/
1Через Skills CLI (Vercel)
npx skills add first-fluke/oh-my-agent --skill oma-docs -a codex2Вручную: положить файлы
.agents/skills/oma-docs/SKILL.mdДля всех проектов — ~/.agents/skills/
1Через Skills CLI (Vercel)
npx skills add first-fluke/oh-my-agent --skill oma-docs -a cursor2Вручную: положить файлы
.cursor/skills/oma-docs/SKILL.mdCursor читает и .agents/skills/, и .claude/skills/
1GitHub CLI
gh skill install first-fluke/oh-my-agent skills/oma-docs2Вручную: положить файлы
.github/skills/oma-docs/SKILL.md1Через Skills CLI (Vercel)
npx skills add first-fluke/oh-my-agent --skill oma-docs -a gemini-cli2Командой платформы
gemini skills install https://github.com/first-fluke/oh-my-agent --path skills/oma-docsВручную: положить файлы
.devin/skills/oma-docs/SKILL.mdСтарый путь .windsurf/skills/ тоже читается
Claude.ai
Упакуйте папку в zip и загрузите в Settings → Capabilities → Skills
По шагам, с командами для каждой платформы: Как установить скилл в Claude Code: пять способов
Вопросы об oma-docs
Как установить oma-docs в Claude Code?
Подключите маркетплейс и установите плагин командами /plugin marketplace add first-fluke/oh-my-agent и /plugin install oma@oh-my-agent. Также можно запустить установку через терминал: npx skills add first-fluke/oh-my-agent --skill oma-docs -a claude-code.
Что делает oma-docs?
Проверяет ссылки в Markdown-документах, отслеживает рассинхронизацию документации после правок в коде через Git-дифф и фиксирует дрифт переводов.
Что произойдёт, если в системе не установлен CLI oma docs?
Агент вручную разберёт Markdown-файлы, найдёт локальные ссылки и изображения и проверит их доступность. Сетевые URL http(s) при этом останутся в отчёте с пометкой о непроверенном статусе.
Исходный текст
SKILL.md · MIT
--- 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)`, ``, 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).
© First Fluke · MIT · first-fluke/oh-my-agent