readme-writer

Solid

README やプロジェクトのトップページ(repo を開いた人が最初に見る入口)を書く・直すときに使う。こんな時に必ず呼ぶ — README が長い/文字の壁で読まれない→短く走査しやすくしたい、開いて数十秒で「何のプロジェクトで自分向けか」が伝わる入口にしたい、構成図・アーキ図を入れたい(PNG や架空図でなく Mermaid を勧める)、badge を貼りすぎたので整理したい、長い rationale や「なぜ」を docs/ に逃がしたい、研究・DOI repo の README を引用付きで読める長さにまとめたい。短く・視覚優先にしつつ、LLM が README 一枚で要点を復元できる情報フロアは残す。CLI でも UI でも研究 repo でも、日本語でも英語でも、新規作成でも既存改善でも対象。AI 専用ドキュメント(llms.txt / llms-full.txt 等)は対象外(→ llms-txt-writer)、記事・エッセイ等の長文 prose は → writing-ecosystem。

AI & Automation 1 stars 0 forks Updated yesterday MIT

Install

View on GitHub

Quality Score: 80/100

Stars 20%
10
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
80
License 10%
100
Description 5%
100

Skill Content

# 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 の中心課題。 ## When to Use - README.md / README.ja.md を新規作成・改善する - repo / プロジェクトの「人間が最初に着地するページ」を整える - 既存 README が「機械寄りで人間に中途半端」/「人間向けに薄すぎて LLM が掴めない」のを直す - README を**短く・視覚優先**にしたいが情報フロアを落としたくないとき **使わない場面**: - `llms.txt` / `llms-full.txt` / FAQ など AI 専用 doc(→ `llms-txt-writer`) - 記事・エッセイ・ブログ等の長文 prose(→ `writing-ecosystem`) - graph.jsonld の設計(→ `jsonld-knowledge-graph`) --- ## 軸は「人間の ATTENTION × LLM の INFORMATION」 README 最適化の本当の対立軸は「人間向け情報 vs LLM 向け情報」ではない。**人間の注意(短く・掴む・走査できる)× LLM の情報(README だけで復元できる)**である。両者は同じ施策に収束する(後述)ので、トレードオフでなく**設計で両取りする**。 ### README は確実に読まれる唯一の surface(だが「only」ではない) - AI 検索 / 引用クローラは **llms.txt を実質読まない**(複数の 2026 ログ調査で大半がゼロリクエスト、主要検索ベンダーは公式に非対応表明)。 - `graph.jsonld` は直接 fetch では plain text 扱いされ、**README の事実の代替にならない**(対照実験)。 - ゆえに **README に置いた情報を「機械層が backstop する」前提で薄くしてはいけない**。 ただし重要な較正: 「LLM は README *しか* 読まない」は強すぎる。正しくは「**generic な paste-URL / 検索 grounding では README が*確実に前提にできる*唯一の面**」。別経路(検索インデックスが他ファイルを既に chunk 済み / README からのリンク追跡 / GitHub connector・API でのファイルツリー露出 / pretraining 由来の知識)も存在する。**結論が最も強いのは匿名 live web grounding と直接ランディング fetch**。逆に **routed coding agent(Claude Code / Cursor 等)は llms.txt を on-de...

Details

Author
shimo4228
Repository
shimo4228/readme-writer
Created
1 months ago
Last Updated
yesterday
Language
Python
License
MIT

Similar Skills

Semantically similar based on skill content — not just same category

Data & Documents Listed

readme-writer

Write, generate, overhaul, or fix a project's README.md (or any "readme", repo front page, or top-level project documentation). Use this skill whenever the user wants to create or improve a README, document a repo, or figure out how to present a codebase to readers — covering libraries and packages, CLI tools, research/ML repos, web apps, services, and developer tooling. Trigger even when the user only says things like "document this project", "write docs for my repo", "make a readme", or points at a codebase and asks how to present it, even if the word "README" never appears.

0 Updated today
Punpun1643
Web & Frontend Listed

build-readme

Write a README from scratch or fully rebuild one. Collects observable facts from the system itself (code, terraform, actual behavior), composes sections from those facts, and writes one fact per bullet; decision rationale and internal how-it-works are left out. An existing README is broken down sentence by sentence and only facts verifiable against the implementation survive. Use when creating, rewriting, condensing, or restructuring a README. Not for a few added lines to an existing README �� a normal edit covers that.

0 Updated yesterday
gitt510
AI & Automation Listed

readme-editor

Create or edit a project's landing documentation set — README.md, AGENTS.md, CLAUDE.md, .github/copilot-instructions.md, and llms.txt — by first deciding which artifacts the repo actually needs, then grilling the user one question at a time with recommended defaults, building a compact README map, using official hyperlinks for named tools and technologies, and only then writing. Inspects the repo before asking anything discoverable. Use when the user wants to create, write, edit, rewrite, audit, polish, or "fix up" a README, AGENTS.md, CLAUDE.md, Copilot instructions, llms.txt, or any project landing/onboarding docs.

2 Updated 5 days ago
YosefHayim