セッションログ
作業セッションの永続的な記録を書き込みます。これらのログは、次に読む人(6週間後のあなたも含め、このコンテキストをまったく持っていない人)にとっての真実の基盤として扱われます。正確性が装飾よりも重要です。
実行すべきタイミング
- ビルド、修正、監査、調査の波が完了したとき
- セッションが終了し、次のセッションが引き継ぐ状態があるとき
- 根本原因が特定され、そのメカニズムを記録する価値があるとき
些細な作業には実行しないでください。1行の修正にログは必要ありません。
保存先
プロジェクトがセッション記録を保存する場所 — docs/sessions/ ディレクトリ、ノート保管庫、Wikiのいずれか。不明な場合は一度確認し、その後は一貫してその場所を使用します。
日付と短い説明を含むファイル名は、ソートとスキャンに適しています:YYYY-MM-DD Short Description.md。
手順
1. 書く前に事実を収集する
会話の記憶だけから書かないでください。 以下の項目を収集します:
- PR番号、コミットSHA、マイグレーションタイムスタンプ、デプロイID
- 実際に検証された内容と、その検証に使用されたコマンド
- 失敗した内容、まだ未解決の内容
- 人間にしかできないこと
事実が確認できない場合は、削除したり断言したりせず、未確認としてマークします。
2. 本文を書く
# YYYY-MM-DD — <根本原因が特定されたもの、または出荷されたもの>
<作業の実行方法を示す1行:誰が計画し、誰が構築し、誰がレビューしたか。>
## 何が起こったか
- メカニズムを最初に。何が起こったかだけでなく、なぜ起こったか。
- 具体的な証拠:PR番号、SHA、タイムスタンプ、行数、ログ行。
- 証明されたことと推定されたことを、明示的に区別する。
## 修正
1. 番号付きの手順。各手順で、何がどのように検証されたかを述べる。
## 絶対にやってはいけないルール
<禁止事項が生まれた場合のみ。それぞれを、それを引き起こしたインシデントに基づかせる。>
## 残存項目 — 人間が必要
- [ ] 人間にしかできないこと
リンク: <関連文書>
ノートシステムがフロントマターを使用する場合は、outcome フィールドを含めます。以前は当てはまらなかったが、今は真であることを述べる完全な1文。 ファイル内で最も読まれる行です。ラベルではなく、実際の主張にします。
3. 誰もが省略する2つのセクション
## 残存項目 とリンクフッターは必須です。 これらは将来に価値をもたらす2つのセクションであり、最も頻繁に省略されるセクションでもあります — ある保管庫で測定したところ、230件の既存ログのうち、これらが出現したのはそれぞれ約21%と約28%のみでした。
毎回両方を書いてください。人間のために本当に保留されているものがない場合は、見出しを削除するのではなく、なし — 保留されているものはありません。 と書いてください。
4. すべての主張にマークを付ける
それぞれに 検証済み(方法) または 推定(未確認の理由) のラベルをインラインで付けます。曖昧にしてはいけません。
「検証済み」は、人間またはコマンドが実際に確認したことを意味します。本番環境に関する主張には、本番環境に対するクエリが必要です — テストの合格、マージされたPR、グリーンのデプロイでは不十分です。
5. 保存する前にすべてのリンクを解決する
各リンクのターゲットを、書き込む前に実際のファイルに対して確認します。ノートシステムはすぐに壊れた参照を蓄積し、無効なリンクだらけのログは誰も信用しません。
6. プロジェクトの状態を更新する
作業によってプロジェクトのステータスが変更された場合は、そのプロジェクトのメインドキュメントに日付付きの状態セクションを追加します — 最新を最初に、先頭に追加し、履歴を上書きしないでください。
作業がハンドオフ文書を持つプログラムを進めた場合は、その文書をその場で更新し、次のセッションが正しく引き継げるようにします。
7. 学んだ教訓をフィードバックする
ユーザーがセッション中に何かを修正した場合は、その教訓を耐久性のある場所(ルールファイル、メモリストア、このスキル自体)に書き込みます。これが、修正が繰り返されないようにする方法です。
ハウススタイル
- 具体的で反証可能にする。曖昧な要約は、ここでは何もないより悪いです。
- ステータスを、どのように確認したかを述べずに主張しないでください。
- 悪いニュースを先に伝える。隠さないでください。
- あなたのコンテキストをまったく持たない読者のために書いてください。
禁止事項
- 既存のログを上書きしないでください。まず読み、その後編集します。
- 機械生成されたディレクトリに書き込まないでください。
- スクラッチファイルやビルド出力をノートの隣に作成しないでください。