Communityライティング&編集github.com

linhai0872/readme-crafter-skill

プロジェクトの種類、ターゲット層、配布モデルを分類し、テンプレートに頼らず誠実で構造化されたREADMEを作成するエージェントスキル。Claude Code、Cursor、Codex、Gemini CLIなど、さまざまなAIエージェントで動作します。

readme-crafter-skill とは?

このスキルは、開発者がAIエージェント(Claude Code、Cursor、Codex、Gemini CLIなど)と連携して、誠実で構造化されたREADMEファイルを作成できるようにします。従来のテンプレートベースのREADME生成とは異なり、このスキルはプロジェクトの種類(ライブラリ、アプリケーション、ツールなど)、対象ユーザー(エンドユーザー、開発者、両方)、配布モデル(npm、PyPI、GitHubリリースなど)を動的に分類します。これにより、読者にとって本当に役立つ情報(例:実際のインストール手順、期待できるユースケース、必要な依存関係)に焦点を当てたREADMEが生成され、無意味なセクションや誇張された主張が排除されます。プロジェクトルートでエージェントに呼びかけるだけで、プロジェクトの実際のコードや構造を解析し、最も適切なセクション構成と内容を提案します。

対応✓Claude Code✓Codex CLI✓Cursor✓Gemini CLI
npx skills add linhai0872/readme-crafter-skill

Installed? Explore more ライティング&編集 skills: steipete/notion, langchain-ai/langchain, bytedance/podcast-generation · View all 6 →

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

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

ドキュメント

readme-crafter-skill は何をしますか?

エージェントスキル:誠実で構造化されたREADMEを作成します。テンプレートに頼るのではなく、プロジェクトの種類、対象読者、配布モデルを分類します。Claude Code、Cursor、Codex、Gemini CLIなど、さまざまなAIエージェントで動作します。

関連スキル