Agent skill

Doc

by boshu2 in boshu2/agentops

Write or update READMEs, docs, repo instructions and handoff notes, checked against source.

Apache-2.0Auto-check passedAgent Workflows

Install Doc

skills CLI
$ npx skills add boshu2/agentops --skill doc -a claude-code

Project install by default; add -g for ~/.claude/skills/.

GitHub CLI
$ gh skill install boshu2/agentops doc --agent claude-code

Project scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).

Manual copy
$ git clone --depth 1 https://github.com/boshu2/agentops.git skills-src && mkdir -p .claude/skills && cp -r skills-src/skills/doc .claude/skills/doc && rm -rf skills-src

Use ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.

Claude Code skills documentation · loads skills from .claude/skills/

Facts

Skill name
doc
GitHub stars
447
Used in
1 other repo
Token cost
~1.9k tokens
SKILL.md length
740 words
Files
21 (incl. scripts, references)
Skills in repo
31
Repo updated
First seen
Licence
Apache-2.0

At a glance

Write or update READMEs, docs, repo instructions and handoff notes, checked against source.

  • Works in 5 steps: Identify the audience, question and… → Read the relevant declarations and… → Make the smallest useful edit. Explain… → …
  • : documenting something
  • SKILL.md covers Modes, Grounded writing, Missing-document setup and Session handoff, plus 1 more section
  • Writing a README

What it does

Doc is an agent skill from boshu2/agentops. Write or update READMEs, docs, repo instructions and handoff notes, checked against source. Use when: documenting something, writing a README or leaving a session handoff.

Its SKILL.md is about 1.9k tokens, which your agent loads only when the skill is triggered. The skill folder holds 22 other files, including scripts and reference files (for example `references/agentops-internal.md`, `references/architecture-report.md` and `references/bootstrap/context-routing.md`).

It sits in Agent Workflows, covering Technical documentation and Session handoff. The repository describes itself as: DevOps discipline for AI coding agents: shape the work, track it as a graph, and get each change judged by a context that didn't write it. The licence is Apache-2.0.

When your agent uses it

  • : documenting something
  • Writing a README
  • Leaving a session handoff

Example prompts

  • “/doc”

Workflow steps

5 steps, taken from the first numbered list in SKILL.md.

  1. Identify the audience, question and existing document owner. Reuse accepted
  2. Read the relevant declarations and verify them against code, configuration,
  3. Make the smallest useful edit. Explain non-obvious rules, ordering and tradeoffs
  4. Check links, examples and the repository's applicable documentation build or
  5. Return changed paths and check results, plus unresolved factual gaps. Write a

What it can do on your machine

Read from SKILL.md and the folder at commit 3bdbfed. It shows what the files ask for, not the result of running them.

  • Tool permissions

    Pre-approves nothing: there is no allowed-tools line, so your agent's usual permission prompts apply.

    From allowed-tools in the SKILL.md frontmatter.

  • Runs code

    Ships 1 file in scripts/, which the agent can run.

    From the folder's file list and the shell code blocks in SKILL.md.

  • Network

    No URLs in SKILL.md.

    From URLs in SKILL.md, links to its own repository left out.

  • Credentials

    Names no API keys, tokens, secrets or passwords.

    From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.

Context cost

Doc loads about 1.9k tokens when it runs, and up to ~24k if it reads all its reference files. Until then it costs about 44 tokens; SKILL.md has 740 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it
~44
When it runs · the whole SKILL.md, loaded when a task matches
~1.9k
With references · SKILL.md plus every file in references/, read only if the agent opens them
~24k

Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.

Safety

Auto-check passed

The automated check found no risky patterns in SKILL.md.

Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); the scripts in this folder are not scanned.

SKILL.md

The full file from boshu2/agentops at commit 3bdbfed, republished under its Apache-2.0 licence (© boshu2). 740 words, ~1,889 tokens.

Download SKILL.mdSave it as .claude/skills/doc/SKILL.md (or your agent's skills folder). This skill also uses 20 other files; get the full folder from GitHub.
name
doc
description
Write or update READMEs, docs, repo instructions and handoff notes, checked against source. Use when: documenting something, writing a README or leaving a session handoff.
practices
wiki-knowledge-surface, code-complete, pragmatic-programmer
hexagonal_role
supporting
consumes
repo-context
produces
documentation, session-handoff
skill_api_version
1
user-invocable
true
context.window
fork
metadata.capabilities
doc, initialize_missing_docs, write_session_handoff
metadata.effects
write_documentation, write_requested_handoff, create_requested_evidence_directory
metadata.canonical_status
canonical

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 and source; use code/API guidance or architecture guidance when useful.
Create or improve a READMELead with the user's problem and a working first-use path; preserve useful depth. See README craft.
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.
Preserve a session for another contextFill the handoff template and deliver it as described there.

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.

Grounded writing

  1. Identify the audience, question and existing document owner. Reuse accepted intent; ask only for missing content that materially changes the document.
  2. Read the relevant declarations and verify them against code, configuration, command help or executable behavior. Use the caller's domain terminology. 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.
  4. Check links, examples and the repository's applicable documentation build or validator. Remove empty claims and redundant prose; prose guidance can help when the requested output is substantial.
  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.

Show full SKILL.md (337 more words)Show less

Session handoff

A requested handoff records end-state facts another context can verify. Fill every field. Write unknown with the reason for any fact you did not observe; record a caller's unobserved claim as "stated, unverified", never as fact.

markdown
# Handoff: <goal, one line>
- Goal and acceptance: <accepted goal>; acceptance <met | not met | unknown>
- Done: <change or artifact> (<exact path, commit or command>) -> <observed result>
- Failed or withdrawn: <attempt> -> <observed failure or reason> | none
- Open: <unmet acceptance, findings, causal gaps> | none known
- Stop state: <native state and where it was read> | unknown
- Remaining allowance: <measured time, cost or turns left; helper use for the current incident when it matters> | unknown
- Identities: <repository and commit; runtime, session or context IDs and resume links as observed> | unknown
- Continuation: <caller-supplied next step> | none supplied
  • IDs: record only observed identities. A remembered, approximate or reconstructed ID is unknown; at most quote it as the caller's unverified claim.
  • Stop state: a note or report saying HOLD, paused or done is only a note. Read the state from its native owner (tracker, runtime, goal controller) or write unknown.
  • Allowance: compaction, a new session or a handoff resets no budget, allowance or helper incident. Carry the measured remainder or unknown.
  • Failures: keep informative failures and withdrawn claims so the next context does not repeat them.
  • Sessions: do not assign a whole multi-work session to one task. Follow session associations for startup and resume links; end-state notes cannot replace missing startup evidence.

Destination. A new CDLC handoff, draft or proof goes only to the selected protected external non-Git destination; with none selected, report the missing routing and create no fallback file. For any other handoff a location the caller names wins: write there, read it back and return the exact path. With no named location, return the handoff in the response and create no file. Check source, recipient/model and destination authorization before copying metadata; an opaque locator grants no access. AgentOps evidence routing and the ao session handoff commands are in AgentOps internals.

Writing a handoff changes no tracker, Git, runtime or verdict state. The native caller keeps owning the authorized outcome; this mode does not select work or decide continuation for it.

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.

© boshu2, Apache-2.0. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file

Files

SKILL.md and 20 other files (scripts, references) in skills/doc of boshu2/agentops.

  • SKILL.md
  • references/agentops-internal.md
  • references/architecture-report.md
  • references/bootstrap/context-routing.md
  • references/bootstrap/examples.md
  • references/de-slopify.md
  • references/default-mode.md
  • references/doc.feature
  • references/generation-templates.md
  • references/oss-docs.feature
  • references/oss-documentation-tiers.md
  • references/oss-pack.md
  • references/oss-project-types.md
  • references/project-types.md
  • references/prose-and-report-workmanship.md
  • references/readme-craft.md
  • references/readme.feature
  • references/validation-rules.md
  • scripts
  • … and 2 more

Open the folder on GitHubat commit 3bdbfed

Used in 1 other repository

We found 1 copy of this SKILL.md (exact, near-identical or edited) in other folders, from 1 other GitHub owner. This page covers the copy in boshu2/agentops, which our catalogue first saw on October 7, 2026.

Compare with similar skills

Doc next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.

Doc compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
Doc this skillboshu2/agentops4471 repos~1.9kAutomated safety check: PassApache-2.0
Fantasia Final Cleanupvishiri/fantasia-archive409—~1.2kAutomated safety check: PassGPL-3.0
Orca CLIstablyai/orca87k2 repos~593Automated safety check: PassMIT
Neat-Freak Knowledge CloseoutKKKKhazix/khazix-skills21k—~1.9kAutomated safety check: PassMIT
Beads Task Memorygastownhall/beads28k—~1.2kAutomated safety check: PassMIT
Compound Learning WriterEveryInc/compound-engineering-plugin25k—~2kAutomated safety check: PassMIT

Similar skills

  • Fantasia Final Cleanup

    vishiri/fantasia-archive

    End-of-batch ship workflow for Fantasia Archive: run full yarn testbatch:verify (not dev scoped gate), fix failures, sync README/AGENTS/rules/skills from Git changes, update in-app changelog, split…

    409 GitHub stars~1.2k tokensUpdated today
    DevelopmentAuto-check passed
  • Orca CLI

    stablyai/orca

    Operate Orca-managed worktrees, folder contexts, terminals, repos, automations, artifacts, skill sharing, worktree comments, and Orca's embedded browser…

    87k GitHub starsUsed in 2 repos~593 tokens
    Agent WorkflowsAuto-check passed
  • Neat-Freak Knowledge Closeout

    KKKKhazix/khazix-skills

    Brings project docs, agent rule files, authorized memory and leftover workspace files back in line with what the code and runtime actually do at the end of a work session.

    21k GitHub stars~1.9k tokensUpdated 7 days ago
    Agent WorkflowsAuto-check passed
  • Beads Task Memory

    gastownhall/beads

    Tracks multi-session work with dependencies in the bd issue tracker so the agent can find ready tasks and recover its context after conversation compaction.

    28k GitHub stars~1.2k tokensUpdated today
    Agent WorkflowsAuto-check passed
  • Compound Learning Writer

    EveryInc/compound-engineering-plugin

    Records one solved and verified problem as a durable learning in the repository, but only when the reasoning is not already clear from the final code, tests or docs.

    25k GitHub stars~2k tokensUpdated today
    Agent WorkflowsAuto-check passed
  • Compound Learnings Refresh

    EveryInc/compound-engineering-plugin

    Audits a repo's stored learnings against the current codebase, fixes stale, overlapping or superseded docs and reports on every document.

    25k GitHub stars~2k tokensUpdated today
    Agent WorkflowsAuto-check passed

More from boshu2/agentops

All 31 skills in this repo
  • Agent Native

    boshu2/agentops

    Dispatch independent tasks to parallel workers or subagents without write collisions.

    447 GitHub starsUsed in 1 repo~1.9k tokens
    Auto-check passed
  • Council

    boshu2/agentops

    Compare independent opinions from several models or contexts without inflating agreement.

    447 GitHub starsUsed in 1 repo~3k tokens
    Auto-check passed
  • Craft Goal

    boshu2/agentops

    Draft or lint a bounded long-running goal prompt with a finish line and hard limits.

    447 GitHub starsUsed in 1 repo~2.7k tokens
    Auto-check passed
  • Idea Genie

    boshu2/agentops

    Brainstorm evidence-backed options for what to build, or stress-test an idea.

    447 GitHub starsUsed in 1 repo~1.8k tokens
    Auto-check passed
  • Implement

    boshu2/agentops

    Change or repair code, config or services without weakening tests; report what ran and what did not.

    447 GitHub starsUsed in 1 repo~2.3k tokens
    Auto-check passed
  • Memory

    boshu2/agentops

    Write, find or curate lessons and agent rules with stated evidence and limits.

    447 GitHub starsUsed in 1 repo~1.6k tokens
    Auto-check passed

Questions about Doc

What does Doc do?

Write or update READMEs, docs, repo instructions and handoff notes, checked against source. Doc is an agent skill from boshu2/agentops. Write or update READMEs, docs, repo instructions and handoff notes, checked against source.

When should I use Doc?

Doc fits situations like: : documenting something; writing a README; leaving a session handoff.

How do I install Doc in Claude Code?

Run `npx skills add boshu2/agentops --skill doc -a claude-code`. Or copy the skill folder (skills/doc in boshu2/agentops) into .claude/skills/doc in your project. Claude Code loads it when a task matches its description.

How do I install Doc in Codex?

Run `npx skills add boshu2/agentops --skill doc -a codex`. Or copy the skill folder (skills/doc in boshu2/agentops) into .agents/skills/doc in your project. Codex loads it when a task matches its description.

Can I use Doc in Cursor, Gemini CLI or GitHub Copilot?

Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add boshu2/agentops --skill doc -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/doc, .gemini/skills/doc, .github/skills/doc and .opencode/skills/doc in your project.

What does Doc need to run?

SKILL.md names no scripts, command-line tools or credentials: Doc is instructions for the agent only.

Does Doc access the network?

SKILL.md contains no URLs. Any network use would come from the scripts or tools the agent runs. This is read from the text; nothing was executed.

Is Doc safe to install?

Our automated static check of SKILL.md found no risky patterns, such as piping downloads into a shell, reading credential files or hidden Unicode. It is not a guarantee. The check reads SKILL.md only: the scripts in the folder are not scanned, so read them before running anything.

What licence does Doc use?

Doc is published under the Apache-2.0 licence (the repository's licence). It allows redistribution, so the full SKILL.md is shown on this page.

How many tokens does Doc use?

About 1.9k tokens (SKILL.md is roughly 7.6k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full. Its references folder adds about 22k tokens, read only when the agent opens those files.

What are the alternatives to Doc?

Skills that share tags, products or a category with Doc: Fantasia Final Cleanup (vishiri/fantasia-archive, 409 stars), Orca CLI (stablyai/orca, 87k stars), Neat-Freak Knowledge Closeout (KKKKhazix/khazix-skills, 21k stars) and Beads Task Memory (gastownhall/beads, 28k stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains Doc?

boshu2 (a GitHub user) maintains it in boshu2/agentops, which has 447 GitHub stars. The repository holds 31 skills in this directory. The repository was last updated on October 7, 2026.

Source: boshu2/agentops on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.