デザインドキュメント
コードに現れづらい文脈や経緯・前提・考慮事項・メンタルモデルなどを記す文書
コードの読解や議論・システムの考古学等に有用
単に情報を補完あるいは整理することを目的としたドキュメントであり、何か特定のフォーマットに従っていなければならないようなものではないlemonadern.icon
引用・参考
チームメイトや将来の自分がこのコードを読むときに首をかしげそうな気配を感じたらとりあえず書くブログ記事のようなものである。文量もフォーマットも決まった物はないし、必ずしも書いた時点で正確でなくていい。どういう現状認識をしていてどういうメンタルモデル(もしくは誤解)に基づいてどんな意思決定をしたかをありのままに書き記しておけばレビューのときにそこを含めて議論ができるし後から考古学をするハメになったときにも大いに助けになる。