deepresearch-readme
Installation
SKILL.md
Deepresearch Readme
GitHub OSS向けREADMEを、短時間で「何ができるか」と「どう始めるか」が伝わる状態に整える。
進め方
- 前提を確定する。
- プロジェクト種別を特定する: ライブラリ / CLI / Webアプリ / GitHub Action
- 対象読者を特定する: 利用者 / 評価者 / コントリビューター
- READMEの目的を確定する: 新規作成 / 改善 / レビュー
- ファーストビューを構成する。
- H1にプロジェクト名を書く
- 1〜2文で価値を書く(技術スタック説明より先に価値を出す)
- Quickstartへの最短導線を置く
- 必要な主要リンクだけを置く(Docs、Issues、Releases)
- Quickstartを最短化する。
Requirements、Install、Runの順で3〜6行程度に収める
Related skills