deepresearch-readme

协助创建、改进及评审 GitHub 开源项目的 README.md。围绕 What/Why/How to start/Help/Maintainers 轴整理信息，构建最短可运行的 Quickstart 和通往文档的路径。用于新建 README、重构现有 README、评审 README 以及判断是否需要分割文档时。触发条件：“创建 README”、“改进 README”、“添加 Quickstart”、“GitHub 专用 README 模板”、“评审 README”等与 README 相关的请求。

SKILL.md

--- frontmatter

name: deepresearch-readme
description: >
  GitHub OSS向け README.md の作成・改善・レビューを支援する。What/Why/How to start/Help/Maintainers
  の軸で情報を整理し、最短で動かせる Quickstart と docs への導線を構成する。
  READMEの新規作成、既存READMEの再構成、READMEレビュー、ドキュメント分割の判断時に使用する。
  トリガー：「READMEを作って」「READMEを改善して」「Quickstartを追加して」
  「GitHub向けREADMEテンプレ」「READMEをレビューして」などのREADME関連リクエスト。

Deepresearch Readme

GitHub OSS向けREADMEを、短時間で「何ができるか」と「どう始めるか」が伝わる状態に整える。

進め方

•前提を確定する。

•プロジェクト種別を特定する: ライブラリ / CLI / Webアプリ / GitHub Action
•対象読者を特定する: 利用者 / 評価者 / コントリビューター
•READMEの目的を確定する: 新規作成 / 改善 / レビュー

•ファーストビューを構成する。

•H1にプロジェクト名を書く
•1〜2文で価値を書く（技術スタック説明より先に価値を出す）
•Quickstartへの最短導線を置く
•必要な主要リンクだけを置く（Docs、Issues、Releases）

•Quickstartを最短化する。

•Requirements、Install、Run の順で3〜6行程度に収める
•実際に実行できるコマンドだけを残す
•OS差分が長くなる場合は docs/installation.md へ分離する

•構成を仕上げる。

•セクションは以下を基本とする:
•Highlights
•Quickstart
•Usage
•Documentation
•Getting help
•Contributing
•License
•詳細説明は docs/ に切り出し、READMEには相対リンクだけ残す

•最終検証を行う。

•5分以内に「導入→最小実行」までたどれるか確認する
•リンク切れ、前提バージョン、手順の古さを確認する
•references/readme-review-checklist.md で網羅確認する

出力テンプレート

README本文を作るときは references/readme-template.md のテンプレートを優先して使う。

レビュー方針

既存READMEをレビューするときは以下を優先する。

•Critical

•Quickstartが実行不能
•必須情報（What/How to start/Help）が欠落
•READMEが巨大化し、開始手順が埋もれている

•Warning

•セクション順が読み手の意思決定順とずれている
•docsへの導線が弱い
•バッジやリンクが多すぎて価値が伝わりにくい

•Info

•表現の簡潔化
•例の追加（CLI実行例、最小コード例）
•FAQやトラブルシューティングへの導線追加

参照ファイル

•実践チェックリスト: references/readme-review-checklist.md
•README雛形: references/readme-template.md