Agent SkillsYeachan-Heo/oh-my-claudecode › agent-doc-discipline

agent-doc-discipline

GitHub

规范Agent可消费文档的写作纪律,确保自包含、可检查且步骤清晰。适用于CLAUDE.md等Agent交互文档,强制用于种子生成和发布审查,提升机器可读性。

skills/agent-doc-discipline/SKILL.md Yeachan-Heo/oh-my-claudecode

触发场景

生成Agent可执行文档如CLAUDE.md或CONTEXT.md 编写或编辑供Agent读取的技术规范、Ticket或Skill文件 Drydock种子生成阶段 Launch C5沉积传递阶段的文档写入

安装

npx skills add Yeachan-Heo/oh-my-claudecode --skill agent-doc-discipline -g -y
更多选项

不安装直接使用

npx skills use Yeachan-Heo/oh-my-claudecode@agent-doc-discipline

指定 Agent (Claude Code)

npx skills add Yeachan-Heo/oh-my-claudecode --skill agent-doc-discipline -a claude-code -g -y

安装 repo 全部 skill

npx skills add Yeachan-Heo/oh-my-claudecode --all -g -y

预览 repo 内 skill

npx skills add Yeachan-Heo/oh-my-claudecode --list

SKILL.md

Frontmatter
{
    "name": "agent-doc-discipline",
    "level": 3,
    "description": "Writing-time discipline for documents agents consume (the five surfaces, specs, tickets, .omc\/skills\/) — every rule checkable and carrying a why, steps before reference, one meaning in one home, no restating what the environment already says. Mandatory at drydock seed generation and the launch C5 sediment pass; opt-in for any other agent-facing doc edit. The companion of minimal-code-discipline: that one disciplines code, this one disciplines papers."
}

Agent Doc Discipline

Use this skill to apply a writing-time discipline while creating or editing any document an agent consumes to act: the five surfaces (CLAUDE.md, CONTEXT.md, docs/standards/, design-system/, .omc/skills/), specs, tickets, and skill files. The test a document must pass: a fresh agent session can act on it by reading alone.

Mandatory when: drydock generates surface seeds, the launch C5 sediment pass writes a lesson into a slot. Opt-in for every other edit — but any edit to an agent-facing document should survive these rules.

When Not to Use

Documents written for humans only: docs/business/ narrative, ADR decision stories, READMEs for human onboarding. They may still follow the rules where it costs nothing, but they are not held to this discipline.

The Discipline

Write for a reader with no chat history. The document is self-describing: nothing leans on "as discussed", a prior session, or knowledge that lives in someone's head. Test: a brand-new agent session can act on the document by reading alone.

Every rule checkable and carrying a why. No "keep it clean" — write the observable condition and the reason. Test: an agent can decide pass/fail from the text alone, and the why is stated next to the rule.

One meaning, one home. Each rule or definition has a single authoritative place; duplication is drift waiting to happen. Test: changing a behavior is a one-place edit.

Never restate what the environment confesses. Package scripts, directory layouts, --help output are lookups, not documents — a copied lookup goes stale. Document only what cannot be found by looking: the unwritten convention, the reason behind a choice, the gotcha. Test: every line survives "can this be looked up elsewhere?".

Steps first, reference behind, rare material behind a pointer. What to do, in order, at the top; consult-on-demand rules below; low-frequency material pushed behind a pointer whose wording names the branches that should trigger reaching it. Test: the next action is findable within the first screen.

Every step ends on a completion criterion. Done must be tellable from not-done — a vague bound invites premature completion. Test: for each step, "how do I know this is finished?" has an answer in the text.

A procedure longer than two steps is numbered. The numbers are stable references: a reader can name step 3, follow the order, and jump without re-reading. An unnumbered procedure of many steps makes the reader hold the order in their head. Test: every procedure of three or more steps carries its numbers.

A list is capped at what a reader holds in one glance. A list that outgrows the reader's grasp loses its point — nothing in it is findable. A longer enumeration becomes structure (a table, subsections) or splits. This governs the writing of documents; it never touches the machinery of a gate or a batched decision, which lives in the methodology, not the prose. Test: every list in the document fits in one glance, and any longer enumeration has become structure.

Deferred and scheduled work states when. A document that defers work to a later step, session, or release states that timing next to the work it defers — "when" is a fact the reader needs to act, and an unstated deferral reads as an unstarted one. The timing is stated in the prose only; it never rebinds a checkpoint the methodology pushes right deliberately. Test: every deferral in the document carries its when.

Close on a next action a reader can start now. A report, ticket, or session-close pointer ends not with a summary but with the one next step a reader can begin in under two minutes — the destination, the pointer, or the command. A close that only summarizes makes the reader re-derive what to do first. Test: the last line answers "what do I do next?" without scrolling up.

Re-state the position each time the reader rejoins. A document a returning reader touches mid-flight (a long spec, a run report, a map Notes section) opens the new material with where things stand — step, phase, or decision count — before adding anything new. Test: a reader arriving cold can locate the current state in the first two lines of the newest section.

Prompt the positive. State the target behavior; a prohibition is reserved for hard guardrails and is always paired with the positive target. Test: every prohibition in the document names the thing to do instead.

Scrape barnacles on write. When the document contains stale or redundant material, remove it in the same edit; when it does not, add only the required material and do not invent deletions. A sentence the model already obeys by default pays load for nothing — delete the whole sentence. Test: every line re-read earns its place against "does this change behavior versus the default?", and any stale or redundant material found during the edit is gone.

Verification

Before reporting a document change done, confirm:

  • a fresh session could act on it without asking a human anything
  • every rule is checkable and states its why; no rule restates a lookup
  • meanings live in one place; pointers name their trigger branches
  • stale or redundant material found during the edit was removed, while valid unrelated content was preserved
  • closes end on a next action the reader can start now; rejoining readers find the current state stated before new material
  • procedures of three or more steps are numbered; lists fit in one glance; every deferral states its when

版本历史

  • 9fd35ec 当前 2026-09-22 13:48

同 Skill 集合

skills/ai-slop-cleaner/SKILL.md
skills/architecture-survey/SKILL.md
skills/ask-navigator/SKILL.md
skills/ask/SKILL.md
skills/autopilot/SKILL.md
skills/autoresearch/SKILL.md
skills/cancel/SKILL.md
skills/ccg/SKILL.md
skills/configure-notifications/SKILL.md
skills/debug/SKILL.md
skills/deep-dive/SKILL.md
skills/deep-interview/SKILL.md
skills/deepinit/SKILL.md
skills/diagram/SKILL.md
skills/drydock/SKILL.md
skills/execute/SKILL.md
skills/external-context/SKILL.md
skills/graph/SKILL.md
skills/harbor/SKILL.md
skills/hud/SKILL.md
skills/intent/SKILL.md
skills/learner/SKILL.md
skills/local-build-reminder/SKILL.md
skills/loft/SKILL.md
skills/mcp-setup/SKILL.md
skills/merge-readiness/SKILL.md
skills/minimal-code-discipline/SKILL.md
skills/minimal-prose-discipline/SKILL.md
skills/omc-doctor/SKILL.md
skills/omc-reference/SKILL.md
skills/omc-setup/SKILL.md
skills/omc-teams/SKILL.md
skills/plan/SKILL.md
skills/project-session-manager/SKILL.md
skills/ralph/SKILL.md
skills/ralplan/SKILL.md
skills/release/SKILL.md
skills/remember/SKILL.md
skills/research/SKILL.md
skills/review/SKILL.md
skills/sciomc/SKILL.md
skills/self-improve/SKILL.md
skills/setup/SKILL.md
skills/skill/SKILL.md
skills/skillify/SKILL.md
skills/team/SKILL.md
skills/trace/SKILL.md
skills/ultragoal/SKILL.md
skills/ultraqa/SKILL.md

元信息

文件数
0
版本
9fd35ec
Hash
628eed7f
收录时间
2026-09-22 13:48

首页 - Wiki
Copyright © 2011-2026 iteam. Current version is 2.155.2. UTC+08:00, 2026-09-22 15:06
浙ICP备14020137号-1