跳到主内容
智客 ZICQ

技能库 智客分类:文档办公 doc

Doc

编写被禁用的文件、 README 、 repo 指令或连续性交接 。 需要这些文件时使用;没有报告作为例行的完成仪式.

1498 安装量

官方网址:skills.sh

技能介绍

先看中文介绍;官方 description 原文单独保留,不改写 SKILL.md。

做什么

编写禁用的文件、 README 、 Repo 指令或连续性交接

何时用

要求这些文件;没有报告作为例行的完成仪式

代理如何加载

按 Agent Skills 渐进披露:启动时只加载 name 与 description(约 100 token);任务匹配后才读入整份 SKILL.md 正文;scripts/、references/、assets/ 仅在需要时再读。 本文件正文结构:Doc、Modes、Grounded writing、Missing-document setup、Session handoff、Reference menu。

文件分析

文件分析:除 SKILL.md 外,正文引用了 references/default-mode.md、references/architecture-report.md、references/readme-craft.md、references/oss-pack.md、references/bootstrap/examples.md、references/de-slopify.md,属于带资源的技能包,这些文件按需再读。

官方 description(原文)

Write grounded docs, READMEs, repo instructions or continuity handoffs. Use when: these documents are requested; no reports as a routine completion ritual.

DocModesGrounded writingMissing-document setupSession handoffReference menu

来源分类:skills.sh agent-skill

SKILL.md 与 Agent 调用

官方规范 ↗
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.
  1. 发现技能客户端向 Agent 提供名称与描述目录。
  2. 匹配与调用用户指定或任务匹配后,载入 SKILL.md 指令。
  3. 按需加载按步骤读取参考文档、使用脚本与素材。
指令中引用的文件 · 12
  • references/default-mode.md
  • references/architecture-report.md
  • references/readme-craft.md
  • references/oss-pack.md
  • references/bootstrap/examples.md
  • references/de-slopify.md
  • references/SESSION_FORMATS.md
  • references/generation-templates.md
  • references/project-types.md
  • references/oss-documentation-tiers.md
  • references/oss-project-types.md
  • references/prose-and-report-workmanship.md

以下路径提取自原文;文件是否齐全请以来源仓库中的完整目录为准。

具体调用语法与可用工具以目标 Agent 客户端为准。 查看调用机制说明 ↗

安装这个技能

Skills CLI ↗

先选择目标 Agent 和安装范围,保留技能包的附属文件,安装后检查客户端能否发现该技能。

该技能引用了附属文件,请从来源获取完整目录;仅复制 SKILL.md 可能缺少依赖。

交给 Agent 安装

复制安装指令给支持 Agent Skills 的代理,确认其中的目标目录与客户端匹配。

把 Agent Skill「doc」安装到我的项目:SKILL.md 原文与官方 description 见 https://zicq.com/zh/skills/skl-f18af22fb17b1192-%E5%8C%BB%E7%94%9F.html
请存为 .cursor/skills/doc/SKILL.md 或 .claude/skills/doc/SKILL.md,frontmatter 的 name 与 description 保持原样,不要改写。
该技能还带 scripts/、references/、assets/ 等文件,请从 https://github.com/boshu2/agentops 取完整目录,不要只建一个 SKILL.md。

GitHub 完整包 ↗

终端安装 · Skills CLI

需要 Node.js 与 npx。先查看仓库技能列表,确认实际名称。

npx skills add 'https://github.com/boshu2/agentops' --list

npx skills add 'https://github.com/boshu2/agentops' --skill 'doc'

CLI 会交互选择目标 Agent,默认安装到项目;用户级安装使用 -g。先通过查看命令核对仓库内容,再用 npx skills list 检查已安装技能。

阅读排版

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

  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.

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.

相关技能

文档办公

Ontology

为结构化的代理内存和可堆肥技能所打入的知识图. 在创建/征服实体(Person, project, Task, Evention, Document)时使用,链接相关对象,强制约束,规划多步动作作为图变,或技能需要共享状态时使用. 触发到"记住","我知道什么","链接X到Y",…

文档办公

Nano Pdf

使用纳米-pdf CLI编辑带有自然语言指令的PDF.

文档办公

Word / DOCX

创建,检查,并编辑有可靠样式的Microsoft Word文档和DOCX文件,编号,跟踪更改,表格,章节,并进行相容性检查. 当 (1) 任务涉及 Word 或 ".docx " 时使用; (2) 文件包括跟踪的更改,评论,字段,表格,模板,或页面布局限制; (3) 文档必须在不…

文档办公

Api Gateway

通过 Maton 网关调用第三方 API, 它为用户已经连接的应用程序注入证书 。 当用户命名一个连接的应用程序和其中的具体行动时使用此技能——读取一个邮箱,查询一个CMM,归档一个问题,更新一个电子表格,通过一个连接的搜索或刮取提供者运行一个查询. 每一次通话都到用户连接的应用…