mcpField
G
generate-readme

generate-readme

github.com/cowork-os開発51450 回インストール今日更新
リポジトリ

generate-readme について

generate-readme は、プロジェクトの README を作成・更新するスキルです。セットアップ、使い方、貢献方法を含むオンボーディング向けの草稿を作成し、パッケージツールによる API ドキュメント生成には使いません。

主な機能

  1. 01README 全体の草稿作成
  2. 02セットアップ・使い方・貢献方法の記載
  3. 03既存プロジェクト文書の更新

活用シーン

  1. 01プロジェクトのオンボーディング文書作成
  2. 02プロジェクト README の更新
  3. 03セットアップと貢献方法の整理

インストール

コマンドをコピーしてターミナルで実行します。

$npx skills add https://github.com/cowork-os/cowork-os --skill generate-readme

インストール後、Claude Code で/generate-readmeを入力して読み込まれたか確認します。

詳細

README の生成

目的

プロジェクトの README.md を作成します。

ルーティング

  • 使用する場合：ユーザーがプロジェクトのドキュメントの生成または更新を依頼した場合に使用します。
  • 使用しない場合：パッケージのツールによって生成される API ドキュメントには使用しないでください。
  • 出力：オンボーディングに使用できるセクションを含む、README の完全なドラフトです。
  • 成功基準：セットアップ、使用方法、コントリビューションを一貫したドキュメントにまとめます。

トリガー例

肯定
  • この依頼には generate-readme スキルを使用してください。
  • generate readme を手伝ってください。
  • ユーザーがプロジェクトのドキュメントの生成または更新を依頼した場合に使用します。
  • README を生成してください：実行可能な内容を提示してください。
否定
  • パッケージのツールによって生成される API ドキュメントには使用しないでください。
  • 無関係な依頼には generate-readme を使用しないでください。
  • この依頼は generate readme の対象外です。
  • これは概念的な議論のみです。ツールのワークフローは必要ありません。

ランタイムプロンプト

  • 現在のランタイムプロンプトの長さ：558 文字。
  • ランタイムプロンプトは ../generate-readme.json で直接定義されています。

コメント

Markdown 対応