README作成
ドキュメント入門
プロジェクトのコード、設定ファイル、ディレクトリ構造を分析し、インストール方法、使い方、コントリビューションガイドを含む完成されたREADME.mdを生成します。
トリガー
/readme使用頻度プロジェクト開始時
オープンソースに初めてコントリビュートする開発者なら？ /readmeでプロ品質のREADMEを素早く完成
サイドプロジェクトを公開するときなら？ きれいなREADMEで第一印象を好印象に
READMEドキュメントオープンソースオンボーディング
動作フロー
/readme 実行 → プロジェクト分析
↓
フェーズ1: 4つのセクション生成を並列実行
overview-gen
プロジェクト概要
install-gen
インストールガイド
usage-gen
使用例
contrib-gen
コントリビューションガイド
↓
Markdown結合 + バッジ追加
↓
✓ 完成されたREADME.md
スキルコード
# README Builder Skill
## Trigger: /readme
When invoked:
1. Analyze project:
- Package name, description, license
- Tech stack and dependencies
- Available scripts (build, test, lint)
- Project structure
2. Generate README.md:
---
# Project Name
[1-line description]
[badges: build, coverage, license, version]
## Features
- ✨ [feature 1]
- 🚀 [feature 2]
## Quick Start
\`\`\`bash
# Install
[install command]
# Run
[run command]
\`\`\`
## Usage
[code example with explanation]
## Project Structure
\`\`\`
src/
├── [dir] — [description]
└── [dir] — [description]
\`\`\`
## Contributing
[contribution guide]
## License
[detected license]
---
コピーしてCLAUDE.mdに貼り付ければ、すぐに使えます。
README作成 の仕組み
README Builderはプロジェクトのファイル構造、package.json、既存のドキュメントを分析し、インストール手順、使用例、APIリファレンス、コントリビューションガイドラインを含む包括的なREADME.mdを生成します。
README作成 が力を発揮する場面
プロジェクトをオープンソース化するときや新しいチームメンバーのオンボーディング時に不可欠です。プロジェクトの理解、インストール、コントリビューション開始に必要なすべてをカバーするプロフェッショナルなREADMEを作成します。
主な強み
- 正確なコンテンツのため実際のプロジェクト構造を分析
- インストール、使用方法、コントリビューションセクションを生成
- バッジ提案と目次を含む
- オープンソースプロジェクトに適したプロフェッショナル品質