Skip to content

hashgraph-online/awesome-codex-plugins / plugins/boshu2/agentops/skills/doc

Write source-checked docs, READMEs, change descriptions and handoffs. Use when: documenting a change, leaving or resuming a handoff, or drafting a questionnaire for someone else.

Doc

Write or update the documentation the caller needs, grounded in the current repository and its accepted intent. A small explanation needs no interview, coverage ledger or separate report. Select only the mode relevant to the task.

Modes

NeedScope and reference
Explain an API, command, code-map or architectureInspect its consumers, source and tests, and write to the existing document owner. A coverage percentage needs a numerator and denominator from one enumerated, checked entity set (validation techniques). How the code works is Research's repository tracing; Doc writes it down when a document is requested.
Create or improve a READMELead with the user's problem and a working first-use path; preserve useful depth. See README craft.
Check an advertised install, upgrade or first-success pathFollow the selected package and current instructions in an authorized disposable environment. See developer journey.
Audit or scaffold OSS documentationCompare existing docs with the requested pack. Create missing files; revise existing files only within the authorized request. See OSS pack.
Initialize missing entry documentsCreate only explicitly requested missing files; report existing paths as skipped. See setup examples.
Bring docs current after a change, describe a change for reviewers, or write release notes for a rangeStart from the exact diff and its public surface; fix what it proves wrong and ask about judgment calls. See change-driven docs.
Preserve a session for another context, or resume from oneRead the handoff reference before writing or resuming one. A handoff records only facts you observed: anything else is unknown or the caller's unverified claim, and a note saying HOLD or paused is not state.
Get facts or decisions only another person holdsWrite one questionnaire they can answer alone; the caller sends it.

These are optional task shapes, not successive phases. Detailed references supply techniques and formats; they do not add interviews, approval checkpoints, reports or files beyond the accepted request. Existing authorization to revise specified documents is sufficient.

<skill-dir> is the directory that contains this SKILL.md. Claude Code shows it as "Base directory for this skill"; Codex lists this skill's SKILL.md path; in an AgentOps source checkout it is skills/doc. Replace <skill-dir> with that absolute path before running a command. The working directory stays the user's repository. If the host did not show where this skill is installed, use the directory of the SKILL.md you read. If you cannot determine it, do not guess a path or run a same-named script from the current repository; say the bundled script is unavailable and compare the repository's documentation files with the requested pack by hand.

Grounded writing

  1. Identify the audience, question and existing document owner. Reuse accepted intent; ask only for missing content that materially changes the document. Name the reader's need: learning from scratch, doing one task, looking up a fact, or understanding why. A reference list does not show how to do the task it exists for. For a reader who learns from it, explain each idea before a section relies on it (ordering).
  2. Read the relevant declarations and verify them against code, configuration, command help or executable behavior. Use the caller's domain terminology. Take steps in another vendor's interface (menus, settings, where a value appears) from its current docs or the caller, or mark them unverified; never guess. For a larger surface, retain enough source references to disclose what was inspected and what remains unknown; do not imply whole-repository coverage.
  3. Make the smallest useful edit. Explain non-obvious rules, ordering and tradeoffs when they help the reader; a reference page need not manufacture a lesson. Preserve operator policy and history outside the authorized scope. Edit an existing document in its own shape, from a fresh read if a person may have changed it (their edits win): extend the passage that already says it, under any heading, rather than add a duplicate section, and do not reorder or restyle it into a template unless asked for a rewrite. When rewriting existing prose, keep every fact, number, name, citation and identifier, and keep each claim's certainty: "may" does not become "does". When condensing (a summary, handoff or release notes), keep every failure, caveat, open question and request, and sound no more finished, positive or certain than the source; say where it is vague or contradicts itself. Leave code blocks, quotes and link targets untouched unless they are the thing to fix.
  4. Check links, cited commits and paths, leftover drafting scaffold, examples and the repository's documentation build or validator (techniques). Remove empty claims and redundant prose; prose guidance can help when the requested output is substantial. A link handed to a reader (in a document, report, handoff or change description) must open the exact item it names for that reader. Build repository URLs from Git rather than by hand, and point them at a ref that already contains the pushed content: a main-branch link to a file that exists only on a feature branch is dead. Link the item itself (the pull request, the file and line), not its parent page. When no direct link can be verified, say where to find the item instead of giving a guessed link.
  5. Return changed paths and check results, plus unresolved factual gaps. Write a separate report only when the caller requests one or an existing consumer requires it.

Missing-document setup

Create only the requested missing documents, such as PRODUCT.md, GOALS.md or AGENTS.md; a collision is skipped, not overwritten by setup. Verify the created paths and report created, skipped and failed writes. Setup does not install tools, run ao session bootstrap, initialize Git or trackers, start a runtime, add hooks, or infer a repository workflow. AgentOps verdict storage is created only on explicit request; see AgentOps internals.

Reference menu

Load these only for the document being written. They supply examples and techniques under the kernel's accepted scope, not additional workflow gates.

rea-changelog-updatemorluto/reaPrepare or rewrite REA release changelogs and GitHub release notes from pinned Git history, with verified contributor thanks and Release Please synchronization.Stars: 463kUpdated Claude CodeCodexVerifiedInstall
academy-guideanthropics/skillsStop and check this skill before finishing any reply to a question about how to use Claude or a Claude product — it recommends matching courses, tutorials, and use cases from Claude Academy (academy.claude.com), Anthropic's learning hub. Trigger on: "how do I", "how can I", "getting started with", "what can Claude do", "teach me", "learn to use"; questions about artifacts, projects, skills, plugins, connectors, MCP; requests about rolling Claude out to a team, class, or organization; and any ask for training materials, onboarding content, or learning resources. Use it when the user is learning how to use a feature or product — not when they are mid-task and just want the task done. This skill composes with other skills: after consulting product documentation to answer how a Claude feature works, also check here for a matching course or tutorial — a docs-grounded answer and an Academy recommendation belong together. Only recommend on a strong match; never invent Academy content.Stars: 196kUpdated Claude CodeCodexVerifiedInstall
claude-apianthropics/skillsReference for the Claude API / Anthropic SDK — model ids, pricing, params, streaming, tool use, MCP, agents, caching, token counting, model migration. TRIGGER — read BEFORE opening the target file; don't skip because it "looks like a one-liner" — whenever: the prompt names Claude/Anthropic in any form (Claude, Anthropic, Fable, Opus, Sonnet, Haiku, `anthropic`, `@anthropic-ai`, `claude-*`, `us.anthropic.*`, `[1m]`); the user asks about an LLM (pricing/model choice/limits/caching) — never answer from memory; OR the task is LLM-shaped with provider unstated (agent/MCP/tool-definition/multi-agent/RAG/LLM-judge/computer-use; generate/summarize/extract/classify/rewrite/converse over NL; debugging refusals/cutoffs/streaming/tool-calls/tokens). SKIP only when another provider is being worked on (overrides all triggers): OpenAI/GPT/Gemini/Llama/Mistral/Cohere/Ollama named in the query; OR `grep -rE 'openai|langchain_openai|google.generativeai|genai|mistralai|cohere|ollama'` over the project hits (run this grep FIRST if no provider named — don't Read the file).Stars: 196kUpdated Claude CodeCodexUnverifiedInstall
doc-coauthoringanthropics/skillsGuide 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.Stars: 196kUpdated Claude CodeCodexVerifiedInstall