weiliu1031/writing-readme

writing-readme は何をしますか？

Claude Code スキル。AIエージェントに優れたREADMEの書き方を教えます。awesome-readmeから抽出されたベストプラクティスに基づいています。

概要

このスキルは、Claude Codeエージェントがプロジェクトに対して高品質なREADMEファイルを作成するためのガイドラインを提供します。

含まれる知識

• READMEの目的と重要性
• 必須セクション（プロジェクト名、説明、インストール、使用方法、API、ライセンスなど）
• ベストプラクティス（簡潔さ、明確さ、一貫性）
• マークダウン形式の効果的な使い方

使い方

Claude Codeでこのスキルを有効にすると、エージェントはREADMEを作成する際に、以下のような指示を理解し実行できるようになります：

• 「このプロジェクトのREADMEを生成してください」
• 「READMEのインストールセクションを改善してください」
• 「READMEにコントリビューションガイドラインを追加してください」

ソース

このスキルは、awesome-readmeから抽出された知識に基づいています。