ドキュメント負債について雑感
#エンジニアリングマネジメント(EM) #アプリケーションアーキテクチャ #技術的負債
#共有する
いま、自分のチームは「ドキュメント負債」の返済に追われている。
これまでPoCとして開発していたアプリケーションを商用環境に移行するにあたって、当然ながら各所で妥当性のレビューを受ける必要がある。
これまでチームでは、視点の異なるいくつかのモデルを作り、これを設計ドキュメントと位置づけてきた。
実際のところチーム内の認識合わせにはこれで十分で、新規参画者にもモデルで知識を伝えてきたことから、これ以上のドキュメンテーションは不要と考えていた。
ところが各所のレビューに際しては「なぜそのアーキテクチャ要素を採用するのか」を問われることが多く、ADRを残すことを怠っていたことが発覚した。
(ついでに言うと全体感を示すDesignDocもなかったのだが、PoCによって構成を決めてきた経緯があるのでこれは仕方ない。と思っている。という言い訳)
さてADRを書かずに走ってきた負債を返却すべく、ここ2-3週はまったくインクリメントを作ることができず、「おれたち『開発チーム』じゃなかったっけ?」と自問したくなるような状態が続いている。
これを繰り返さないためにどうしたらよいか。
「ADRを書くことを習慣にすればいい」的な意見を聞くが、そんなことは百も承知の上でできてないから困っている。
嫌なこと・面倒なことは日常に組み込むのが一番だと思うので、その方向でなにか考えたいが、、
問題:
・メンバのドキュメントスキルは揃っていない
・モノによっては、なぜそう決めたかの認識が違う(忘れてる?または実は理解が揃ってなかった?)