← ClaudeAtlas

readme-writerlisted

README やプロジェクトのトップページ(repo を開いた人が最初に見る入口)を書く・直す・判定するときに使う。こんな時に呼ぶ — README が長い/継ぎ足しで文脈が重くなり初見で分からない、開いて数十秒で「何のプロジェクトで自分向けか」が伝わる入口にしたい、冒頭に一目で仕組みが分かる図を置きたい、著者のほかの仕事への導線を付けたい、コードの変更に README を追従させたい、README を判定だけしてほしい、GitHub の About(description / topics / homepage)が README と食い違っている。CLI でも研究 repo でも、日本語でも英語でも対象。AI 専用ドキュメント(llms.txt 等)は → llms-txt-writer、記事・エッセイは → writing-ecosystem、release に伴う version・DOI・数値の同期は → release-doi、文書間の役割の重なりの整理は → context-sync、tagline だけ欲しいときは → headline-craft。
shimo4228/claude-harness · ★ 3 · AI & Automation · score 82
Install: claude install-skill shimo4228/claude-harness
# readme-writer — Human-Facing README Skill 人間に向けた README を書く・改善するスキル。`llms-txt-writer` が AI 専用 surface を担うのに対し、 本 skill は **人間 surface の単一正準入口**を担う。 重要な事実: **README は、grounding 経路(AI 検索 / チャットに repo URL を貼る)で LLM が確実に 前提にできる唯一の surface でもある**。そのため README は「人間向けに短く・走査しやすく」しつつ 「LLM が README 一枚だけ読んでもプロジェクトを復元できる小さな情報フロア」を必ず残す。 この両立が本 skill の中心課題(較正と出典は `inspiration.md`)。 ## モード — 依頼の大きさで選ぶ | モード | いつ | やること | |---|---|---| | **Rewrite** | 新規作成・全面的な作り直し | Workflow の全工程 | | **Incremental** | コードの変更に README を追従させる(implementation-chain の Doc Sync から来る) | 変わった節だけを書き換え、証拠 JSON → readme-judge(mode: draft。変えた節の名前を渡し、判定器が自分で質問を作る)。概要図は仕組みが変わったときだけ描き直す | | **Review-only** | 「この README を見て」「判定だけ」 | 証拠 JSON → readme-judge(mode: draft)。書き換えない | | **About-only** | description / topics / homepage だけ | Workflow Step 6 だけ(`references/about.md`) | 使わない場面: social-preview 画像の作成(どの skill も作らない。著者が GitHub の設定で置く)、 外部ディレクトリ・awesome-list への掲載申請、graph.jsonld の設計(→ `jsonld-knowledge-graph`)。 --- ## 軸は「人間の ATTENTION × LLM の INFORMATION」 README 最適化の対立軸は「人間向け情報 vs LLM 向け情報」ではない。**人間の注意(短く・掴む・走査 できる)× LLM の情報(README だけで復元できる)**である。両者は同じ施策に収束するので、 トレードオフでなく**設計で両取りする**。 - AI 検索 / 引用クローラは llms.txt を実質読まず、`graph.jsonld` は直接 fetch では plain text 扱い。 README の情報は機械層に頼らず README の中に置く(較正: 「LLM は README しか読まない」は強すぎる。 routed coding agent は llms.txt を on-demand で読む — 詳細は `inspiration.md`) - **two-sided rule**: アイデアが*どう伝わるか*は最適化してよい(見出し階層・entity anchoring・ answer-first の lead)。アイデアが*何であるか*は曲げない(keyword st