実装した機能の使用方法を README.md や docs/ 配下にドキュメントとして記述するスキル。新しい機能やコマンドを実装した後、またはユーザーがドキュメント更新・作成を依頼した時にトリガーする。
実装済みの機能・コマンドの使用方法を README.md および docs/ 配下に記述するスキル。プロジェクトの設定ファイル(pyproject.toml 等)とソースコードから情報を収集し、整理されたドキュメントを生成する。README.md は必要最低限の概要に留め、詳細なドキュメントは docs/ 配下に配置する。
README.md を更新する前に、以下のソースから情報を収集する:
pyproject.toml を読み取り、以下を確認する:
[project] セクション: name, version, description, requires-python[project.scripts]: CLI コマンドのエントリポイント[tool.taskipy.tasks]: タスクランナーのコマンド定義[project.dependencies] / [dependency-groups]: 依存パッケージ.env.example または .env: 必要な環境変数を確認する収集した情報をもとに、ドキュメントの配置先を判断する:
docs/ 配下にも作成する場合: 詳細な説明・オプション・使用例が必要な機能docs/ 配下に作成する場合の追加判断:
docs/ に関連する既存ドキュメントがあれば → そのファイルに追記するdocs/usage.md, docs/cli.md, docs/configuration.md)README.md はプロジェクト概要として必要最低限の内容に留める。
# プロジェクト名
プロジェクトの概要(1-2文)
## セットアップ
### 前提条件
- 必要なランタイム・ツール(Python バージョン、uv 等)
### インストール
依存パッケージのインストール手順
### 環境変数
必要な環境変数の一覧と説明(テーブル形式)
## クイックスタート
最も基本的な使い方のみ(数行のコマンド例程度)
## ドキュメント
詳細ドキュメントへのリンク一覧(docs/ 配下にドキュメントがある場合)
- [使い方の詳細](docs/usage.md)
- [CLI リファレンス](docs/cli.md)
## 開発
### 開発環境のセットアップ
開発に必要な追加手順
### タスク一覧
taskipy 等で定義されたタスクの一覧
docs/ 配下のドキュメント詳細な説明が必要な機能は docs/ 配下にドキュメントを作成する。
usage.md, cli.md, configuration.md, api.md)uv run、npm run 等を使い分けるdocs/ 配下のドキュメントがあれば内容を確認し、重複を避けて追記するdocs/ に分離し、README.md からリンクする