決定を残す
決めた日を書く
設計の記録で一番落ちやすいのが日付です。
なぜその案を選んだかは書いても、いつ決めたかを書かない記録がよくあります。日付が無いと、その判断がいまも有効か分かりません。
予算が月5万円だった頃の決定と、月20万円になったあとの決定では、読み方が変わります。
中身が合っているかどうかを、日付で判断します。
2年前の決定を見つけたとき、書かれた条件がいまも同じか確かめます。日付が無い記録は、確かめるきっかけを持ちません。
6つ揃って初めて読める
記録に要るのは6つです。番号、日付、題、背景、決定、そして結果です。
背景と結果を落とさないのが要点です。決定だけ書いた記録は、あとから読んでも理由が分かりません。
Python
# context なぜ決める必要があったか
# decision 何を決めたか
# consequences 決めた結果、何が良くなり何が増えたか分かっている範囲で書きます。
「保存先が2つになるので運用の手が増える」は、決めた時点で分かります。分かっている代償を書かない記録は、都合のよい面だけの記録になります。
あとで想定外のことが起きたら、そのとき新しい記録を足します。古い記録は書き換えません。
演習
記録の材料を受け取り、6つ揃っているか確かめて、揃った項目だけの文書を返します。
要件
- 要る項目は REQUIRED の6つ。record にあって中身が空でないものだけを、REQUIRED の並び順で document に入れる
- missing には、document に入らなかった項目を REQUIRED の並び順で入れる
- document の最後に status を足す。record に status があればその値、無ければ "accepted"。ready は missing が空なら True
ヒント
編集 ゆめさく編集部