mcpField
C
create-readme

create-readme

github.com/hu3rror開発045 回インストール1 日前に更新
リポジトリ

create-readme について

プロジェクトのワークスペースを確認し、構成を整えた README.md を作成するスキルです。関連する例を参考に簡潔な文書を作り、個人リポジトリと確認できた場合は中国語で再構成した README も用意します。

主な機能

  1. 01プロジェクトのワークスペースを確認
  2. 02構成を整えた README.md を作成
  3. 03関連するローカル事例を選択
  4. 04GFM の書式指針を適用
  5. 05個人リポジトリ向け README_zh-CN.md の作成

活用シーン

  1. 01ソフトウェアプロジェクトの文書作成
  2. 02README の構成と読みやすさの改善
  3. 03CLI ツールやサンプル集の文書化
  4. 04個人リポジトリ向け中国語文書の準備

インストール

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

$npx skills add https://github.com/hu3rror/my-skills --skill create-readme

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

同梱ファイル

SKILL.md と一緒にインストールされる参考資料やスクリプト。

references/
azure-chat-rag-langchainjs.md
azure-serverless-recipes.md
run-on-output.md
smoke.md

詳細

役割

あなたはオープンソースプロジェクトで豊富な経験を持つ、シニアソフトウェアエンジニアです。作成する README ファイルは、魅力的で、情報が充実し、読みやすいものになるよう常に心がけています。

タスク

  1. 深呼吸して、プロジェクトとワークスペース全体を確認し、包括的で構成の整ったプロジェクト用の README.md ファイルを作成してください。
  2. 以下の README の例（このスキルと同じ階層にある references/ 内のローカルコピー）を参考に、構成、トーン、内容を決めてください。すべて読むのではなく、プロジェクトの種類に最も近いものを選んでください。
    • Serverless AI Chat with RAG using LangChain.js — Web アプリ全体の README：バッジ付きヘッダー、概要、機能、セットアップとデプロイの手順、リソース
    • Serverless Recipes for JavaScript/TypeScript — サンプル集の README：概要、前提条件、実行手順、サンプル一覧
    • run-on-output — CLI ツールの README：簡潔な説明、機能一覧、インストール方法、使用例
    • smoke — 開発者向けツールの README：概要、まず簡単な例を紹介し、インストール方法と詳細な使用方法を説明
  3. 絵文字を使いすぎず、簡潔で要点を押さえた README にしてください。
  4. 「LICENSE」「CONTRIBUTING」「CHANGELOG」などのセクションは含めないでください。これらのセクション専用のファイルが別途用意されています。
  5. 書式には GFM（GitHub Flavored Markdown）を使用し、適切な箇所では GitHub のアラート構文（https://github.com/orgs/community/discussions/16925）を使用してください。
  6. プロジェクトのロゴやアイコンが見つかった場合は、README のヘッダーに使用してください。
  7. 特に指定がなければ、README は英語で作成してください。gh api user --jq .login の結果とリモートの所有者が一致するかどうかで、個人リポジトリかを判断してください。一致を確認できない場合は外部リポジトリとして扱ってください。個人リポジトリの場合は、英語の README を中国語で再構成した README_zh-CN.md も作成してください。技術的な事実、対象範囲、使用手順、主な制限事項は同じにしつつ、一文ずつ翻訳するのではなく、内容を中国語で再構成してください。2つのファイル間に相互リンクを追加してください。

コメント

Markdown 対応