doc
boshu2/agentops
Write grounded docs, READMEs, repo instructions and session handoffs without routine reporting.
What is doc?
A documentation skill for writing or updating READMEs, API docs, architecture guides, and session handoffs grounded in repository context. Use it when documentation is explicitly requested—not as a default completion ritual. Supports multiple modes: explaining APIs and architecture, creating or improving READMEs, auditing OSS documentation, initializing missing entry documents, and preserving session state for handoff.
- Write or update READMEs with user problems and working first-use paths
- Explain APIs, commands, code maps and architecture by inspecting consumers and source
- Create or revise OSS documentation packs, scaffolding missing files within authorized scope
- Initialize missing entry documents like PRODUCT.md, GOALS.md, or AGENTS.md
- Preserve session end-state facts and continuity handoffs for another context
How to install doc
npx skills add https://github.com/boshu2/agentops --skill docHow to use doc
- 1.Identify the audience, question and existing document owner, reusing accepted intent
- 2.Read relevant declarations and verify them against code, configuration or executable behavior
- 3.Make the smallest useful edit, explaining non-obvious rules and tradeoffs when they help the reader
- 4.Check links, examples and applicable documentation validators; remove empty claims and redundant prose
- 5.Return changed paths, check results and unresolved factual gaps without inventing a separate report
Use cases
- Document a new API or command by inspecting its consumers and verifying behavior against code
- Improve an existing README to lead with user problems and preserve useful depth
- Audit and scaffold missing OSS documentation files within an authorized request scope
- Create missing entry documents to establish repository structure and continuity
- Write a compact session handoff recording goals, artifacts, commands, findings and remaining work
- Repository maintainers and documentation owners
- Open-source project leads auditing or scaffolding documentation
- Developers handing off work or session state to another context
- Teams establishing repository structure and continuity documentation
doc FAQ
Use this skill when documentation is explicitly requested. Do not use it as a routine completion ritual or to generate reports unless the caller specifically asks for one.
Documentation grounded in the current repository: verified against code, configuration, command help or executable behavior, with source references disclosed and unknown gaps reported.
No. It creates only explicitly requested missing files and revises existing files only within the authorized request scope. Collisions are skipped, not overwritten.
Accepted goal, completed artifacts and evidence paths; commands and observed results; repository identity and measured remaining allowance; permitted dispatch/startup associations; and caller-supplied continuation.
No. Setup does not install tools, run bootstrap, initialize Git or trackers, start a runtime, add hooks, or infer a repository workflow.
Full instructions (SKILL.md)
Source of truth, from boshu2/agentops.
name: doc description: 'Write grounded docs, READMEs, repo instructions or continuity handoffs. Use when: these documents are requested; no reports as a routine completion ritual.' practices:
- wiki-knowledge-surface
- code-complete
- pragmatic-programmer hexagonal_role: supporting consumes:
- repo-context produces:
- documentation
- session-handoff
context_rel: []
skill_api_version: 1
user-invocable: true
context:
window: fork
intent:
mode: task
sections:
exclude:
- HISTORY metadata: capabilities: [doc, initialize_missing_docs, write_session_handoff] effects: [write_documentation, write_requested_handoff, create_requested_evidence_directory] canonical_status: canonical disposition: keep_specialist tier: product dependencies: [] output_contract: requested documentation or handoff with source references, check results and explicit gaps
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
| Need | Scope and reference |
|---|---|
| Explain an API, command, code-map or architecture | Inspect its consumers and source; use code/API guidance or architecture guidance when useful. |
| Create or improve a README | Lead with the user's problem and a working first-use path; preserve useful depth. See README craft. |
| Audit or scaffold OSS documentation | Compare existing docs with the requested pack. Create missing files; revise existing files only within the authorized request. See OSS pack. |
| Initialize missing entry documents | Create only explicitly requested missing files; report existing paths as skipped. See setup examples. |
| Preserve a session for another context | Write the compact factual handoff described below to the caller's authorized destination. |
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
- Identify the audience, question and existing document owner. Reuse accepted intent; ask only for missing content that materially changes the document.
- 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.
- 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.
- 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.
- 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.
For AgentOps itself, read docs/contracts/ubiquitous-language.md: the product
is the operations layer for agentic engineering. Preserve the distinction
between that layer and caller-owned execution, work tracking and delivery.
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.
Standalone verdict storage at .agents/ao/verdicts/sha256/ is created only when
explicitly requested. New CDLC proof uses the caller-selected protected external
non-Git evidence root; a missing route permits no checkout fallback. Preserve
existing evidence and use the repository's actual source owners.
Session handoff
A requested handoff records end-state facts another context can verify:
- accepted goal, completed artifacts and exact evidence paths;
- commands and observed results, unresolved acceptance, findings and causal gaps;
- useful repository/content identity, observed native stop state and measured remaining allowance or explicit unknowns; record whether the helper for a current HOLD incident was used when that fact matters to continuation;
- permitted dispatch/startup association and observed runtime/session/context identities, with separately evidenced parent/resume links and source bounds;
- caller-supplied continuation, when present.
Follow session associations for those identities. End-state notes cannot replace missing startup evidence. Do not invent IDs, infer a paused goal from a report saying HOLD, assign a whole multi-work session to one task, or reset budgets and helper incidents through compaction. Preserve informative failures and withdrawn claims.
Check source, recipient/model and destination authorization before copying metadata. An opaque locator grants no access. New CDLC handoffs require the selected protected external non-Git destination; preserve legacy evidence and report missing routing without creating a fallback file. Otherwise use the caller's named location and read it back after writing.
Existing JSON under .agents/handoff/ remains read-only evidence.
ao session handoff writes .agents/ao/handoff/; ao session rehydrate searches
both and selects the newest lexical ID, preferring the canonical directory for
an identical filename. Those commands do not establish startup associations or
external storage authorization. Return the exact path to Markdown consumers.
Writing a handoff changes no tracker, Git, runtime or verdict state. The native caller continues owning the authorized outcome; this documentation 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.
- Formats and examples: generation templates, project types.
- OSS scope: documentation tiers, OSS project types.
- Writing and checks: prose workmanship, validation techniques.
- Explicit context configuration: context routing.
Related skills
More from boshu2/agentops and the wider catalog.

evolve
Run autonomous improvement loops that measure, fix, and compound.

flywheel
Check knowledge flywheel health. Triggers: "flywheel", "check knowledge flywheel health.", "flywheel skill".

forge
Mine transcripts into learnings. Triggers: "forge", "mine transcripts into learnings.", "forge skill".

goals
Deprecated alias for fitness skill—use fitness instead to measure project goals.

handoff
Write compact session handoff artifacts with exact evidence paths for context handoff without choosing continuation.

heal-skill
Repair skill hygiene. Triggers: "heal-skill", "heal skill", "repair skill hygiene.".