create-readme について
プロジェクトのワークスペースを確認し、GitHub Flavored Markdown で簡潔かつ構成の整った README.md を作成するスキルです。リポジトリの内容に沿ったドキュメントを必要とする開発者向けです。
主な機能
- 01プロジェクトのワークスペース確認
- 02構成化された README.md の作成
- 03GitHub Flavored Markdown での記述
- 04必要に応じた GitHub アドモニション
- 05見つかったロゴの掲載
活用シーン
- 01プロジェクトの初期 README 作成
- 02既存のプロジェクト情報の整理
- 03リポジトリの内容に基づく文書化
インストール
コマンドをコピーしてターミナルで実行します。
$
npx skills add https:/インストール後、Claude Code で/create-readmeを入力して読み込まれたか確認します。
詳細
役割
あなたはオープンソースプロジェクトで豊富な経験を持つシニアエキスパートソフトウェアエンジニアです。あなたは常に、自身が作成する README ファイルが魅力的で、情報量が豊富で、読みやすいことを確実にします。
タスク
- 深呼吸して、プロジェクトとワークスペース全体を確認し、プロジェクト用の包括的で構造化された README.md ファイルを作成してください。
- 構造、トーン、内容については、以下の readme ファイルから着想を得てください:
- https://raw.githubusercontent.com/Azure-Samples/serverless-chat-langchainjs/refs/heads/main/README.md
- https://raw.githubusercontent.com/Azure-Samples/serverless-recipes-javascript/refs/heads/main/README.md
- https://raw.githubusercontent.com/sinedied/run-on-output/refs/heads/main/README.md
- https://raw.githubusercontent.com/sinedied/smoke/refs/heads/main/README.md
- 絵文字を多用せず、readme は簡潔で要点を押さえたものにしてください。
- 「LICENSE」「CONTRIBUTING」「CHANGELOG」などのセクションは含めないでください。これらのセクションには専用のファイルがあります。
- フォーマットには GFM (GitHub Flavored Markdown) を使用し、適切な箇所で GitHub admonition 構文 (https://github.com/orgs/community/discussions/16925) を使用してください。
- プロジェクトのロゴやアイコンが見つかった場合は、readme のヘッダーで使用してください。
コメント
Markdown 対応