mtai0524/claude-skills

機能追加、セットアップ変更、環境変数追加時などにREADME.mdとプロジェクトドキュメントを自動的に同期します。新しい機能を追加した後や、ユーザーがドキュメントの更新を依頼した際に使用します。

claude-skills とは?

このスキルは、プロジェクトのREADME.mdを常に最新の状態に保つためのものです。機能追加、セットアップの変更、環境変数の追加など、プロジェクトのインストール方法、実行方法、設定、利用方法に影響を与える変更が行われた場合に、同じ変更の中で自動的にREADME.mdを更新します。対応プラットフォームはClaude Code、Cursor、CodexなどのAIエージェントです。このスキルは、プロジェクトの説明(1-2文)、要件とインストール手順、実行・テスト・ビルドのコマンド、全環境変数の目的と例、主要機能の使用例といった必要最小限の情報をREADMEに含めることをガイドします。変更があったセクションのみを編集し、全ファイルを書き換えることはありません。また、ドキュメント内のすべてのコマンドが実際に動作することを確認するルールに従います。

対応✓Claude Code~Codex CLI~Cursor
npx skills add https://github.com/mtai0524/claude-skills/tree/HEAD/skills/docs-readme

Installed? Explore more 生産性&コラボレーション skills: steipete/gemini, steipete/gh-issues, steipete/skill-creator · View all 6 →

お気に入りのAIに質問する

このエージェントスキルを事前に読み込んだ状態で新しいチャットを開きます。

ドキュメント

ドキュメント & README

プロジェクトのインストール方法、実行方法、設定方法、利用方法に影響を与える変更があった場合は、同じ変更内で README.md を更新してください。

READMEには、以下の内容を簡潔に記載する必要があります。

  • プロジェクトの説明(1-2文)
  • 要件とインストール手順
  • 実行方法、テスト方法、ビルド方法 — コピー&ペースト可能なコマンド
  • 設定: すべての環境変数について、目的とサンプル値(実際の秘密情報は含めないこと)
  • 主要機能の簡単な使用例

ルール:

  • 変更が影響するセクションのみを編集すること。ファイル全体を書き換えないこと。
  • ドキュメント内のすべてのコマンドが実際に動作することを確認すること。
  • 英語を使用し、短い文章で、マーケティング用の表現は避けること。

Individual skills in this repo

This repo contains 4 individual skills — each has its own dedicated page.

関連スキル