ds-ledger

ds-ledger

長時間の作業では、その目的を見失いがちです。短い記録を残しておけば、目標を見失わず、レビュアーも結果を信頼できます。

手順

1. たとえば .ds-ledger.tsv のような TSV ファイルを1つ作成し、ヘッダーに ts phase decision why evidence result を指定します。最初の行に目標と完了条件を記載します。
2. 各ステップの前に、目標の行と直近10行を読み直します。次のステップが引き続き目標に沿っているか確認します。沿っていない場合は、逸脱を記録して軌道を修正します。
3. 実際の判断を下すたびに、次の内容を1行追加します。
   • ts：ISO 8601 形式の時刻。
   • phase：フェーズまたは作業の流れ。
   • decision：選択または実行したことを1行で記載します。
   • why：理由を平易な言葉で記載します。
   • evidence：説明文ではなく、参照先を記載します。コミットハッシュ、file:line、コマンドとその結果、成果物のパスなどです。
   • result：「テスト成功」「取り消し」「未解決」などの結果。
4. 各セルは1行に収め、タブを入れないでください。
5. 作業の取り消しや中断も、理由とともに記録します。失敗の記録が最も役立ちます。
6. 最後に要約の行を追加し、ユーザーにファイルの場所を伝えます。レビュアーが必要とする場合にのみ、コミットします。

次の場合に終了します

• 作業が終了し、要約の行を記載したとき。
• 3行連続で目標に向けた進展がない場合は、作業を停止して報告します。

ルール

• すべての行に、開いたり再実行したりできる証拠が必要です。「問題なさそうだった」は証拠になりません。
• チームメイトに伝えるように、平易かつ具体的に記載します。
• 古い行を書き換えないでください。修正は追記します。