外部設計書や内部設計書を効率よく理解する方法を教えてください。 SE2年目になります。 設計書を書くことが増…

Question

外部設計書や内部設計書を効率よく理解する方法を教えてください。

SE2年目になります。

設計書を書くことが増えたのですが、まず読めなくて困っています。

効率の悪い読み方をしているのか、理解も作業も進まず時間ばかりが過ぎていきます。

先輩方にここの処理何してるんですかと聞いても「設計書読めばわかるじゃん」と言われると切なくなります。分かれば聞いてない(；ω；)

以下私の設計書作成の様子です。

・膨大な文字が並んでいるのを見ると、どこに目をつけていいか分からず混乱

・噛み砕いて読むを繰り返すうちに、前に噛み砕いたものの内容がわからなくなる

・結局ここらへんの処理は何のためあるの？となり、また考え直すを繰り返す

・設計書とプログラムと照らし合わせる時も、微妙な書き方の差を吸収できず、いちいち何処に何があるかを探し回る

（関係ないですが、地図を見て実際の道と照らし合わそうとするも全く出来ない時の感覚に似てます。向いてないんですかね、、）

・細かいとこまで見てる筈なのに、理解できてないからか質問されても答えれない。何も覚えてない。調べ直し。以下エンドレス。

要領の悪さと、出来の悪さと、あまりに作業の進まないことによる居心地の悪さに胃がきりきりします。

・どうすれば効率よく読み解けるか
・どう質問すれば周囲にこの状況に手を差し伸べてもらえるか
・どうすれば設計書作成タスクを完了までもっていけるか（最悪理解できていなくとも）

以上について教えて頂きたいです。
その他アドバイス、お叱り何でも頂けると嬉しいです。

どうか私の安眠を取り戻すためお力添えをお願いいたします。
賢くなりたい。

Answer 1

シーケンス図やクラス図はありますか?
あればシーケンス図で処理を追いながら、設計書を読むと理解しやすいと思います。
シーケンス図やクラス図が無い場合はプログラムをステップ実行して作ります。
処理を理解する為なので、この場合のクラス図はメソッド名と戻り値だけで引数は記述しなくても構いません。

ソースコードから後付の仕様書や設計書を作る仕事もあるので、上記のような技術は役に立ちます。

Answer 2

重要なのは効率ではなく正しく理解することです

詳細の理解が進まないのは、全体像が理解できていないためと思われます

まず全体像(概要設計)をなんとなくでも理解して、自分の中で詳細設計内容をイメージ(予測)してから詳細設計の資料を見ることをお勧めします

自分なりに詳細設計のイメージを事前に予測しておいてから、実際に詳細設計された資料を読むと予想が当たっている部分と外れている部分がハッキリわかります

あとは予想が外れている部分だけ理解すれば良いので作業は大幅に減ります

また資料をただ読むだけではなかなか頭に入りませんよね
自分とは違う経験値を持った別の人が考えた構造ですから、相手の考えに合わせて読まなくてはなりません
なんでこうしたのか？こういう方法もあったのでは？など、自分なりの考えと対比して読んだりすると理解が早まりますし知識も増えます

プログラムと設計書を照らし合わせて確認しているなら、先ずは変数を中心に整理してから処理(計算の流れ)を追うことをお勧めします
原本のソースファイルに勝手に手を加える訳にはいきませんから、自分のPCにソースをコピーしてから設計書に照らしてソースにコメント(ここは設計書の〇ページの〇〇の処理等)を付けていけば、後で読み返した時に再解析する手間が省けます

あとは自分なりに試行錯誤を繰り返していくうちに自分にとって一番やりやすい方法が見つかりますよ
最初のウチは慣れない作業で手間取ることも多いでしょうが、作業効率は慣れれば勝手に上がっていきますよ

Answer 3

社内ＳＥをしているものです。

外部設計書・内部設計書というレベル感が、私が思っているので違うこともあるかもしれませんが、一般的なことで伝えたいと思います。

こういう設計書というのは、必ずINPUTとOUTPUT、そしてProcessの３つに分けれます。内部設計書や外部設計書を読む前に、概要設計書レベルで、もっと大きく処理全体を捉えることが重要と思います。
その概要設計書レベルの処理で、INPUTとOUTPUTは何か？という点が一番重要です。
そこから、順に細かく見ていくようにすべきです。

これって、地図を見る感覚と似ていると思いますよ。

頑張ってください。

Answer 4

ただ仕様書を読んで、頭で理解しようとしていませんか？
仕様書を読むことに慣れていれば、そういったことも出来ますが、仕事に慣れていないのであれば、途中でわからなくなって当然だと思います。

理解するために、あなたが理解できる資料を作ってください。
全体は何をしているシステムで、その画面はどのような処理をしているのか、など、噛み砕いたのならそれを書いて、いつでも戻って確認できる状態にしてください。
何となく理解した気がする、くらいで、先に進めば、直ぐに詰むと思います。

＞・どうすれば効率よく読み解けるか

理解した事を直ぐに振り替えられるような資料を作る。

＞・どう質問すれば周囲にこの状況に手を差し伸べてもらえるか

○○は□□だと思いますが、合ってますか？
○○は□□の処理ですか、それとも△△の処理でしょうか？
など、YESかNOで答えられる質問にしてから尋ねる。

＞・どうすれば設計書作成タスクを完了までもっていけるか（最悪理解できていなくとも）

理解できなくても、と思っているようでは、仕事は終わりません。
概要→設計書 といけないのなら、その間に大まかな処理を描いたフローチャートなど、自分の中で理解できるまで処理の内容や順番を整理してください。

２年目になれば、だんだんとフォローは無くなっていきます。
そのまま、理解することを辞めたら、この業界では詰みます。