ドキュメント作成を工数見積もりに含めないとそうなる

2020/10/26

投げっぱなし

すいとーと完結おつ。ごきげんよう。

設計書書きながらコード書くのが結果的に最速、という結論に最近は落ち着いています。
(ていうか唐突)

一時期はJavadocのようなコードからドキュメントを生成するしくみもいいなと思っていたんですが、やはり物足りなさを感じます。
コメントに書けることなんてたかが知れているというか、設計思想やモジュール構成までは伝えられませんし。

新規作成は普通に設計してから開発でもOKですが、その後は同期させるようにします。
バージョンアップや仕様変更のたびに、ドキュメントとプログラムの同じ箇所を修正する。
という手順を習慣化していけば、資料はつねに最新、現物との差異が発生しなくなります。

この方法のよいところは、脳内スタックの管理が不要になることです。<何
後からまとめて記載しよう、なんて思っていると決まって忘れてしまいがちです。
必要な作業が一度に終わって、やり残したことを覚えておかなくてよいのは精神的に楽です。
年齢とともに記憶力の衰えを感じていますので、記憶に頼らない仕事のしかたに切り替えようと模索中です。

もちろんメンバーが増えてくると管理が大変になるので、何が最善かはプロジェクトの規模によっても変わるかもしれません。

ソーシャル/購読

X Threads note
RSS Feedly Inoreader

このブログを検索

ブログ アーカイブ