逃亡見聞録_d

南から逃げてきた

設計

設計

設計が、ドチャクソ、難しい。

最近、BtoBで稼働してるシステムの設計書を書いている。要はドキュメント作成。正直、設計書なんて楽勝だろう、書いたことないけどなんて甘い考えで臨みました。

どう書いたら良いスカね?フォーマットあります?と尋ねてみると、ハゲ上司がクソ眠たいことをおっしゃる。

「わかるように書け。フォーマットは無い」こいつ死んだらいいのに。

わかりましたと心の中で唾を吐いたのは良いものの、そもそも設計書なんて見たこともない。というかこのシステム、ドキュメントが残っていない。フォーマットが無いから書かれていないのか、そもそもドキュメント作成なる文化が無かったのか、血眼になって探してみたが、出てくるのはjavadocに書かれた偉人達の愚痴ばかり。ほんと困っちゃうな。ハゲに相談すると、残っているわずかにドキュメント達も最新では無いどころか、前の前の前のバージョンである事実を告げられる。

「ドキュメントは信頼ならない。コードを紐解いて書け。ついで仕様書も作れ」

ながいたびが はじまる...

とりあえず、書き方を調べてみる。

HowToWriteAnEffectiveDesignDocument - 設計文書のうまい書き方