| name | update-readme |
| description | このプロジェクト(decumulate)の README.md を、前回の README 更新コミット以降の変更に基づいて最新化するスキル。
「README を更新して」「前回の README 更新からの差分を確認して README を直して」「README を最新にして」のような依頼で必ず使用する。
git log でコミット履歴を追い、未反映の feat/fix/refactor を特定して README に反映するのが目的。
|
README 更新スキル(decumulate)
目的
README.md は機能説明ドキュメントとして機能する。コード変更と README がずれると、ユーザや将来の自分が誤解する。このスキルは「前回の README 更新から何が変わったか」を git 履歴から自動で追い、内容を正確に反映することを目的とする。
手順
Step 1: 前回の README 更新コミットを特定する
git log --oneline -- README.md
-- README.md を付けることで README.md を実際に変更したコミットだけに絞られる。最上行が前回の更新起点。docs: プレフィックスが多いが、実際にファイルが変わっているかで判断する(git show <hash> --stat で確認できる)。
Step 2: 未反映のコミットを抽出する
git log --oneline <前回READMEコミットのハッシュ>..HEAD
feat: / fix: / refactor: のコミットがあれば、README への反映候補。fix: は軽微なバグ修正が多く反映不要なものも多いが、ユーザ向けに動作が変わるものは反映する。
Step 3: 各コミットの詳細を確認する
反映候補のコミットを git show <hash> または git show <hash> --stat で確認し、ユーザ向けに何が変わったかを把握する。
反映が必要か判断する基準:
| 変更の種類 | README 反映の要否 |
|---|
| 新機能(UI や計算ロジックの追加) | 必要 |
| 既存機能の動作変更(アルゴリズム刷新、UI 挙動変更) | 必要 |
| バグ修正(ユーザが気づく動作の修正) | 場合による |
| リファクタリング(内部実装のみ) | 不要 |
| テスト追加 | 不要 |
| 内部定数・設定値の調整 | 不要(プリセット値変更は場合による) |
Step 4: README を更新する
更新方針:
- 既存セクションの記述を更新する: 機能の動作が変わったなら、既存の説明文を書き換える。古い説明を残したまま追記しない。
- 新機能はセクション or 箇条書きを追加する: 機能一覧(
## 機能)の該当カテゴリに追記。新しい概念(メトリクス、モードなど)は ### サブセクション で詳細説明を追加する。
- ユーザ目線で書く: 内部実装の詳細(関数名、変数名、アルゴリズム名)ではなく、「何ができるか」「何が変わるか」を書く。
- 既存のトーン・スタイルを維持する: 箇条書きの粒度、見出しレベル、日本語の書き方を既存部分に揃える。
Step 5: 変更を確認してコミットする
コミットは /commit コマンドで行う(このスキル内でコミットは行わない)。
このプロジェクトの README 構造
## ローカルで開く # 開発手順
## 機能 # 機能一覧(カテゴリ別)
### 取り崩し戦略 # 5モードの説明
### 口座別・税制対応 # NISA/iDeCo等
### リスク管理 # リバランス/Bond Tent等
### シミュレーション・診断指標
## 結果の読み方 # 名目値/実質値の解説
### 名目値
### 実質値
### 使い分け
### 生活費との比較
### 年率モード時の月額下限/上限
### DIE WITH ZERO # ゼロ着地モードの詳細
### シーケンスリスク
## 注意
新機能を追加するときは、上記のどのセクションが最も適切かを判断してから挿入位置を決める。