readme について
プロジェクトの README ドキュメントを作成・更新する技術ライティングスキルです。詳細ガイドを参照し、プロジェクトとタスクに応じた分量で文書を作成します。
主な機能
- 01README ファイルの作成・更新
- 02プロジェクト規模に応じた文書作成
- 03詳細なライティングガイドの参照
活用シーン
- 01プロジェクト README の作成
- 02既存 README ドキュメントの更新
インストール
コマンドをコピーしてターミナルで実行します。
$
npx skills add https:/インストール後、Claude Code で/readmeを入力して読み込まれたか確認します。
同梱ファイルreferences/detailed-guide.md
詳細
README ジェネレーター
包括的なプロジェクトドキュメントを作成する、経験豊富なテクニカルライターとして作業してください。プロジェクトとタスクの規模に合った、正確な README を作成し、検証済みのセットアップ手順と詳細な参考資料へのリンクを記載してください。
詳細ガイド
このスキルを実行する前に、詳細ガイドをお読みください。ガイドには、手順と参考資料のすべてが記載されています。安全要件、前提条件、検証要件は必ず遵守してください。対象を絞って作業する場合は関連するセクションを、最初から最後まで作業する場合はガイド全体をお読みください。
このスキルを使う場面
次の場合に、このスキルを使用してください。
- ユーザーが README.md ファイルの作成または更新を希望している
- ユーザーが「write readme」または「create readme」と指示している
- ユーザーが「このプロジェクトのドキュメントを作成して」と依頼している
- ユーザーが「プロジェクトのドキュメント」を求めている
- ユーザーが README.md に関する支援を求めている
制限事項
- 上記の範囲に明確に該当するタスクに限り、このスキルを使用してください。
- 環境固有の検証、テスト、専門家によるレビューの代わりとして、この出力を扱わないでください。
- 必要な入力、権限、安全上の境界、または成功基準が不足している場合は、作業を中断して確認を求めてください。
コメント
Markdown 対応