システムエンジニア悩み相談の専門家～目標設定コーチング、フレームワーク勉強会、交流会の企画開催

🔷文書類が全然揃ってないＳＥの現場

自社のシステムを開発していたり、

ある特定のお客さんのシステムの保守を

担当している現場の話です。
 
そこでは、いつも同じシステムに対して、

機能の追加、処理方式の変更等をしているのに

そのシステムに関する資料が、全然揃っていない

という事がよくあります。
 
よく耳にする言葉は、

「うちには決まった設計書が無いので・・・」

とか

「昔、〇〇さんがまとめた事があるけど、
あれどこいったっけ？」
 
設計書などのドキュメント類が揃っていないと、
新しくその現場に配属されたＳＥは、

自分が保守を担当するシステムを理解するため、

ＰＧＭソースを片っ端から

見ていかなくてはなりません。
 
開発経験の浅い新人ＳＥだと

拷問以外のなにものでもありません。
 
とにかく、こんな状況下では、

そのシステム処理構成や、

そのシステムが実現している

顧客の業務について理解することは、

かなり難易度の高いミッションです。
 
もちろん、
そんな文書類が揃っていない事態を

何とかしなきゃと考えている人もいます。

現場によっては、
細々とでもドキュメント整備の活動を

始めるところはあるのですが、

これがなかなかうまく進んでいきません。
 

🔷原因①「検討・議論が不十分なまま始めてしまう」

「品質を向上させるためには、設計書が必要だ」

「設計書は必要だ！

なぜなら品質をもっと向上させないといけないから」
 
「設計書があると便利でしょ？」

「設計書が無いと不便だから、必要でしょ？」
 
別に間違ったことを言っている

とまでは言いませんが、
 
主張から続く根拠の部分がとても希薄な状態のまま

ドキュメントがあるのが当たり前のものとして

何のために、なぜ必要なのか議論がされていないまま

作業を開始してしまう事がよくあります。
 
わざわざ、そんな当たり前の議論をしなくても
と思うかもしれませんが、

ここの認識を合わせないために、

後になってから、その要否、優先度、

ドキュメント様式などで、

ああでもない、こうでもないともめる事になります。
 

🔷大事なこと＜その１＞「文書の目的を明確にする」

そもそも文書には本質的に３つの目的があります。
 

「記録する」

「伝える」

「整理する」
 

これを踏まえて、これから整備しようとしている

文書類の目的をはっきりさせることです。
 
そんな当たり前のことについて、

わざわざ議論しなくてもと思うかもしれません。

しかし、こういった本質的な部分は 人によって、

その捉え方が かなり異なるものです。
 
設計書は何のために作るのか？

一覧表は何のために作るのか？

議事録は何のために作るのか？

 

例えば、設計書について
コードを書くためには必要でしょ？

なんて捉え方だけだと、

コードをそのまま日本語に変換しただけの

設計書になりかねません。
 
こんな文書なら、最初からコードを書いて

プログラムを作った方が早いなんて

考える人もたくさんいます。
 
そのシステムを継続して保守をしていく
ための設計書ならば、次に担当する開発者のために

プログラムからは読み取れないような

開発の前提や背景、複数のプログラムを跨いで

実現している仕様が記載されているべきです。

プログラムをそのまま日本語に翻訳した

設計書はその目的とは真逆のものと言えるかと思います。
 

🔷どこにでもある残念な話

ユーザー企業や大手のSierは、

開発費を抑えるために、

設計工程より後のプログラミングの部分を、
中国のエンジニアにアウトソーシングします。

しかし、中国のエンジニアは要件の部分を

わかっていないため言われたままにしか

プログラムを作ることが出来ません。
 
設計担当は、ほとんどプログラミングをするのと

変らないような設計書を作るしかありません。
 
どこにでもある普通の話です。

百歩譲って、そんな設計書でも
意味があるとしましょう。

いちいちプログラムを見なくても内容がわかるとか。
 
ただ、ここで残念な事が起きます。

そんなコードのとおりにしか書かない設計書が

標準の設計書様式になってしまうのです。
 
作成するのは手間、

頑張って作ったとしてもPGMを読める人にとっては、

大して役に立たないものです。
 
そんな設計書が標準様式になるとどうなるか？

不足分をいつ作るのか？という話になった時に、
設計書の整備はやれる時にやろうと

後回しにしてしまい、いつまで経っても、
必要な文書類が揃わないのです。
 
中国エンジニアへのアウトソーシングで
起きるケースを題材にしましたが、

どんなものでも、
納得出来る目的をちゃんと
関係者同士で認識を合わせないと
文書整備をやりきる事はできません。
 
文書整備がうまくいかない理由

残りに２つについては、次回に続きます。