Skip to content
FunCoding

Search

Search docs, Skills and MCP

oma-docs

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

文档与办公1.3kskills/oma-docs/SKILL.md

Install

Send this to Claude Code, Codex or Cursor. The agent checks the Skill for safety first and installs it only after you confirm.

读取 https://funcoding.ai/skills/first-fluke/oh-my-agent/oma-docs/install.md ,按里面的步骤帮我安装这个 Skill。

SKILL.md

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

FailureRecovery
Missing CLIState 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 scanReport core results and the unverified URL scope
One document cannot be parsedRecord the skipped file and continue other documents
Patch does not applyRe-read the affected current content and make the equivalent authorized correction
Index write failsReport 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 ../_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: ../_shared/core/execution-policy.md (when not already provided).

Similar Skills

pdf
anthropics/skills180k

pdf

Use this skill whenever the user wants to do anything with PDF files. This includes reading or extracting text/tables from PDFs, combining or merging multiple PDFs into one, splitting PDFs apart, rotating pages, adding watermarks, creating new PDFs, filling PDF forms, encrypting/decrypting PDFs, extracting images, and OCR on scanned PDFs to make them searchable. If the user mentions a .pdf file or asks to produce one, use this skill.

Docs & office

discernment-nudge
anthropics/skills180k

discernment-nudge

After you give a substantive answer or draft that the user may act on — advice or recommendations, drafted artifacts such as goals, plans, pitches, proposals, or emails, estimates or projections, analysis or interpretation of data, factual claims they may rely on, or a multi-step argument — invoke this skill BEFORE finalizing your reply and then, if it applies, append 2-3 short follow-up questions, each tied to something specific in what you just produced, that help the user check key facts, probe the reasoning or assumptions, and notice missing context. Do this at most once per conversation. Skip it when the user asked a trivial how-to or simple lookup, wants a purely educational explanation, asked you only to format, convert, or assemble a file from content they provided, is writing code they will run, is doing creative writing or casual chat, or already asked you to double-check, cite, or review — the skill file explains these boundaries and the exact output format.

Docs & office

doc-coauthoring
anthropics/skills180k

doc-coauthoring

Guide users through a structured workflow for co-authoring documentation. Use when user wants to write documentation, proposals, technical specs, decision docs, or similar structured content. This workflow helps users efficiently transfer context, refine content through iteration, and verify the doc works for readers. Trigger when user mentions writing docs, creating proposals, drafting specs, or similar documentation tasks.

Docs & office

docx
anthropics/skills180k

docx

Use this skill whenever the user wants to create, read, edit, or manipulate Word documents (.docx files) or Word templates (.dotx files). Triggers include: any mention of 'Word doc', 'word document', '.docx', '.dotx', or requests to produce professional documents with formatting like tables of contents, headings, page numbers, or letterheads. Also use when extracting or reorganizing content from .docx or .dotx files, inserting or replacing images in documents, performing find-and-replace in Word files, working with tracked changes or comments, or converting content into a polished Word document. If the user asks for a 'report', 'memo', 'letter', 'template', or similar deliverable as a Word or .docx file, use this skill. Do NOT use for PDFs, spreadsheets, Google Docs, or general coding tasks unrelated to document generation.

Docs & office

pptx
anthropics/skills180k

pptx

Use this skill any time a .pptx or .potx file is involved in any way — as input, output, or both. This includes: creating slide decks, pitch decks, or presentations; reading, parsing, or extracting text from any .pptx or .potx file (even if the extracted content will be used elsewhere, like in an email or summary); editing, modifying, or updating existing presentations; combining or splitting slide files; working with templates (.potx), layouts, speaker notes, or comments. Trigger whenever the user mentions "deck," "slides," "presentation," or references a .pptx or .potx filename, regardless of what they plan to do with the content afterward. If a .pptx or .potx file needs to be opened, created, or touched, use this skill.

Docs & office

canvas-design
anthropics/skills180k

canvas-design

Create beautiful visual art in .png and .pdf documents using design philosophy. You should use this skill when the user asks to create a poster, piece of art, design, or other static piece. Create original visual designs, never copying existing artists' work to avoid copyright violations.

Docs & office