common-rules-for-agent-instructions
Installation
SKILL.md
AI向けの文書に共通の心得
Agent SkillやCLAUDE.md・AGENTS.mdのように、AIが読んで従う文書を書く時は、以下の基準に従う。kuden:agent-skill skillとkuden:persistent-instructions skillに共通の心得で、Agent Skillに固有の基準はkuden:agent-skill skillに、ルール文書に固有の基準はkuden:persistent-instructions skillにある。
心得1. 読み手は賢いmodelである
文書を読んで実行するのは、文脈を読んで自分で判断できるmodelである。書くのは、modelが推論では到達できない事だけにする。プロジェクトや作者に固有の方針、隠れた制約、外からは見えない前提、やってみないと分からないgotchaがこれに当たる。
- 考えれば分かる判断を、防御的に明文化しない。edge caseの除外規定や、誤読を防ぐための但し書きを足さない
- 読解力の低いmodelに合わせて設計しない。文脈を読み取れないmodelは、文書が求める他の作業も実行できない
- 手順か例で目的が達成できるなら、背景説明を書かない。インシデントの話や、避けたい結果の説明がこれに当たる。gitの一般的な性質のように、考えれば分かる理由も書かない
- 比喩を書かない。読み手が比喩の別の側面を推論し、文の意味が曖昧になる
心得2. 実行するmodelに向けた事だけを書く
その方法を選んだ経緯や、試して却下した案は、commit messageやPR概要欄に書く。