← ClaudeAtlas

readme-writerlisted

README やプロジェクトのトップページ(repo を開いた人が最初に見る入口)を書く・直すときに使う。こんな時に呼ぶ — README が長い/継ぎ足しで文脈が重くなり初見で分からない、開いて数十秒で「何のプロジェクトで自分向けか」が伝わる入口にしたい、長い rationale・ADR 参照・内部史を docs/ に逃がしたい、研究・DOI repo の README を引用付きで読める長さにまとめたい、GitHub の About(description / topics)が README と食い違っている。証拠スクリプト(readme_evidence.py)+ fresh context の判定器(readme-judge)+ 上限 2 ラウンドの改稿ループ + review panel + 著者通読 GO で回す。短く・走査しやすくしつつ、LLM が README 一枚で要点を復元できる情報フロアは残す。CLI でも研究 repo でも、日本語でも英語でも、新規作成でも既存改善でも対象。AI 専用ドキュメント(llms.txt 等)は → llms-txt-writer、記事・エッセイは → writing-ecosystem。
shimo4228/claude-harness · ★ 2 · AI & Automation · score 81
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`)。 ## When to Use - README.md / README.ja.md を新規作成・改善する - 継ぎ足しで育った README(ADR 参照・姉妹 repo・造語・内部史の密度が上がり、初見で読めない)を根本から作り直す - GitHub の **About(description / topics / homepage)** を README と同じ主張に揃える **使わない場面**: `llms.txt` / `llms-full.txt` / FAQ など AI 専用 doc(→ `llms-txt-writer`)、 記事・エッセイ(→ `writing-ecosystem`)、graph.jsonld の設計(→ `jsonld-knowledge-graph`)。 --- ## 軸は「人間の ATTENTION × LLM の INFORMATION」 README 最適化の対立軸は「人間向け情報 vs LLM 向け情報」ではない。**人間の注意(短く・掴む・走査 できる)× LLM の情報(README だけで復元できる)**である。両者は同じ施策に収束するので、 トレードオフでなく**設計で両取りする**。 - AI 検索 / 引用クローラは llms.txt を実質読まず、`graph.jsonld` は直接 fetch では plain text 扱い。 **README の情報を「機械層が backstop する」前提で薄くしてはいけない**(較正: 「LLM は README しか 読まない」は強すぎる。routed coding agent は llms.txt を on-demand で読む — 詳細は `inspiration.md`) - **two-sided rule**: アイデアが*どう伝わるか*は最適化してよい(見出し階層・entity anchoring・ answer-first の lead)。アイデアが*何であるか*は曲げない(keyword stuffing・疑問見出し farming・ glossary 投下・主張の歪曲は禁止)。star や引用は成功指標ではない --- ## 証拠と判定(code は数える、LLM は判定する) README 品質は「数えられる事実」と「文脈を読む判断」に分かれる。所有者を分ける: | 層 | 何を出すか | 所有者 | |---|---|---| | **証拠** | 第一画面の行数と新語数、ADR / 他 repo / docs への参照数、造語候補の出現表、`<det