myl7/readme-skill

readme-skill とは？

このスキルは、AIエージェント（Claude Code、Cursor、Codexなど）がプロジェクトのREADMEファイルを構造化された形式で作成・更新するための機能を提供します。従来のフリーフォーマットでのREADME作成と異なり、あらかじめ定義されたセクション構成（概要、インストール方法、使用方法、APIリファレンス、ライセンスなど）に従ってドキュメントを生成することで、一貫性と可読性を向上させます。このスキルを使用すると、エージェントはプロジェクトのソースコードや構成ファイルを解析し、必要な情報を適切なセクションに分類・記述できます。特に、複数のプロジェクトを管理する開発者や、AIによるドキュメント自動生成をワークフローに組み込みたいチームにとって有用です。マークダウン形式での出力に対応しており、GitHubやGitLabなどのプラットフォームでそのまま表示可能です。