Geecul

Geekに踊ってカルチャーと寝る

設計書を書き、どのように終わらせるかに悩むんだよね

なんだかんだで新卒から社会人として一般的にはインフラエンジニアと呼ばれる職業でやっている。

そんなインフランジニアとしての仕事で避けられないのが各種ドキュメントや設計書の作成だ。

新しく参画した現場では既存の設計書を読むし、更改案件や新規に製品を導入する場合には新しく設計書を作成したり追記したりすることになる。

最近ではIaC(Infrastracture as Code)の導入も進んでいるようなのでエクセルやワードの設計書ではなくコードで設計から実装まで管理しているところもあるようだが、まだ僕が入ったことのある現場ではそのようなものは導入されていない。

よって、これから書く内容はエクセルやワードで記載された設計書の話であって、一個人として仕事をしながら考えて今でもどのようなスタンスで設計書と向き合うべきなのか悩むよね。という話である。

基本設計書は割と書くべきことが決まっているというか、実現したい機能とか実装する機能、全体感を書きましょうみたいな感じでだいたい何をどう書かなければいけないかというのは分かる。 内容的にもお客さんもレビューしやすいし書いてほしいことがあれば指摘されるのでそこまで書く内容について悩むことはない。

個人的に問題なのは詳細設計書だ。 詳細設計書は各種製品やサーバーのパラメータ値を記載していくことになるのだが、これをどこまで書くかが問題である。

新規に設計書を書くのであれば、製品インストール時から変更した部分のみ書くのか、お客様の要件に対応して実装した部分のみ書くようにするのか、設定値を調べて全部書くのか。

既存の設計書に変更を加える場合には既存の設計書の粒度に沿って書くか、今回の変更で設計書の全体の粒度感が変わるので、既存の設計書で記載されていない内容も新たに現行の実機情報を調べて記載するか、変更部分のみはちゃんと書いておくかとか。

一個人としては時間と体力、仕事としては工数がたくさんあれば、とりあえず設定値について全部書けばよいという話になるが、現実問題それは結構難しい。

お客さんも詳細設計書ぐらいになってくるとレビューが難しくなってくるので、こちらである程度理由を考えて何を書くべきで書かないべきかを判断しないといけない。 ※全部書いてほしいと言われても工数的に難しいと判断したら、工数を増やしてもらうか設計書の粒度や記載方法について相談する必要がある。

とりあえず自分なりに理由を持って書いて、お客さんのレビューをもらってOKであればそれでOKという考え方もある、というか仕事としてはそれ以上でもそれ以下でもないと思う。 納品できないことが一番困るので、粒度とかどのように記載するかみたいなところは現場や状況にあわせて判断して対応している。

ただ、やっぱりあそこは粒度をそろえて既存設計書も調べて落とし込みたかったな。とか思うことはあって難しいなと思う。

設計書一つ書くにしても、フォーマットの制約だったりメンテしていく人のこと考えたり、フェーズを終わらせたい人たちだったり、色々な制約とか思いがあるよねという話でした。