ドキュメントやマニュアルを作らないエンジニアは3流である理由5つ

システムエンジニアの仕事において、「ドキュメント整備」というのは必要不可欠です。

SIerに見積もりを取る際にも、「ドキュメント整備」などが内訳に入っている事もあります。

そして、技術的な作業費用よりも多い事もあります。

ドキュメントやマニュアルを作成するのは技術的な作業より負荷が高い仕事です。

理由は、技術的な作業は効率化することが比較的可能なのに対して、ドキュメントやマニュアルは都度、相手の求める内容や精度が必要になるからです。

さらに言えば、その内容には間違いがあってはいけません。

引き継ぎなどでも使用されるため、その資料は一生利用される可能性もあります。

そして技術的な作業よりマニュアル的な仕事なため、退屈で億劫になってしまう事が大作業でもあります。

しかし、これが無いと非常に仕事が煩わしくなります。

SIerや技術職をしていて、ドキュメントやマニュアルを作成するのは必須である事も多く、多くのエンジニアがこの作業に嫌悪している事もあります。

システムを扱う上で非常に重要であるため、資料をしっかり作成できるようなエンジニアの方が良いでしょう。

しかし、残念ながらこのドキュメントやマニュアル整備が出来ない、しないエンジニアが一定数います。

そんなエンジニアを尊敬しないようにしてほしいですね。

その理由を個人的にですが、書いていきたいと思います。

スポンサーリンク

ドキュメントを整備しないエンジニアは3流

設計書が無い方がおかしいのは当然

システムや機器を導入し運用していく上で、そもそも設計書が存在しないのはプロセスとしておかしいです。

業種によっては、設計書が無い事自体が問題です。

ただ「設計書がない」という事実が問題ではありません。

「いつ」「誰」がどんな「理由」で「設計(設定)」したのか分からなくなる事が問題です。

設計書が無く、誰かが何かの都合で設定を変更した時に、後々問題があるとそもそも設定根拠が追えません。

また設定した本人がいなくなっていると、もはや推測や憶測など、確信がない根拠しか報告できません。

設計書が無い事を知っていながら作成しないエンジニアは無責任です。

自分が見ている時だけしか考えていません。

そして、「設計」から「構築」のプロセスが無いに等しい状態です。

その場合は、トラブルが起きやすい現場になる事もあります。

設計せずにシステムを導入する事は基本的にありません。

無責任は社会人としても3流です。

他のエンジニアの迷惑になる

これは私自身の経験からはっきりと言えます。

設計書があっても古すぎて、メンテナンスしていないせいで実機と全然違う事もありますが、そもそもドキュメントをゼロから作る方が苦痛なのは変わりません。

新しく現場に来たエンジニアは基本的に設計書ベースでシステムを理解する事が多いです。

特に私のようなOracleを扱うエンジニアやインフラエンジニアは特にそうです。

サーバのスペックからデータベースの設定を確認するのは必須です。

とてもじゃないですが、目の前でシステムだけ放り出されても困ります。

データベース系は、アプリケーションのER図なども見れる方が良いです。

設計書やドキュメントを作成しないのは他のエンジニアにとっても迷惑極まりないです。

人手が欲しいのに、人がどんどん辞めていく場合は、属人化していて他の人が手をつけられない事もあります。

ドキュメントがなく長くいる人間の脳内だけにシステムの情報がある場合、新しく来たエンジニアや人間は、情報の確認をするのに人を介在しないといけなくなります。

そして、属人化も良くない働き方です。

もし属人化を肯定するのであれば、新しい人を雇わずに、その人とシステムを心中させる方が良いでしょう。

面倒くさい事を放置しているだけ

これまで書いてきたように、ドキュメントは必要なものであり、他のエンジニアにとっても仕事をしていく上で必要なものです。

必要なのに作成しない人はどういった心理でしょうか。

それはただ単純に「面倒だから」に尽きるでしょう。

実際に業務の標準化や資料作成を指示しても、先延ばしにしたり「忙しい」を理由に作成しない事が多いでしょう。

結局、ドキュメントを作って他人が作業するより「自分がやった方が早い」と思っているからです。

この時点で、組織やチームなどを考えていません。

必要最低限だけ作って自分がやれば良いと思っている事は一切手を付けません。

例えば、上司に「このマニュアルを作って欲しい」と言われたら作るでしょう。

しかし、他の自分が抱える業務の手順書は作らず、仮に退職や異動になっても口頭ベースで引継ぎをするので完全に引き継げずに問題が起こる事が非常に多いです。

スポンサーリンク

非効率を推進するのは3流

手順書があれば工数が減る

先ほどは設計書などのドキュメント類をメインに書いていきましたが今回は「マニュアル」についてメインに書いていきます。

そもそも「手順書」とは、作業を実施するための資料であり、その通りに実施すれば問題なく作業が出来る事を想定して作成します。

つまり、手順書がきちんと整備されていれば「誰でも」その仕事が出来ます。

もちろん、知識レベルによっては難しい事もありますが、少なくとも誰でも作業できるように作るのが手順書です。

「誰でも」出来る作業手順書があるとどうでしょう。

自分の作業工数が減ります。

他の人でも出来るのであれば、忙しい時はお願いしたり出来ます。

また、手順書を通して仕事を理解する事もありますし、逆に無いと「○○を設定してほしい」と指示があったときに「どんな作業」をしたのか分からなくなります。

仕事に効率を求めるのであれば「マニュアル」は必須です。

引継ぎでも役に立ちますし、役に立つという事は効率的に出来ます。

また、口頭のように記憶を頼りにするよりも、データとして残す方が他の人のためになります。

つまり、マニュアルを作成しない人は非効率であると言えます。

責任逃れをする

手順書が無く、誰がが何をしたのか分からないと、問題があった時に「責任逃れ」をするエンジニアがいます。

ミスしたことを謝罪するも何をしたかを一向に言わず「設定値を間違えた」とだけ言う事もあるでしょう。

ミスを認めるのも大事ですが「そもそも本当の事を言っているのか」分かりません。

むしろ、手順書にしてしまう事で、手順書でミスをしてしまうのを恐れているようにも感じます。

会社によっては、システム変更は全て監査対象となる事も多いです。

そんな中で、証跡や手順を整備し、承認プロセスを得て実施するのも一般的な企業が多いです。

属人化して作業をブラックボッス化すると、残念ながらそのような会社や企業では「危険人物」でしかありません。

むしろ、綺麗にドキュメントを整備できるエンジニアの方が実力のあるエンジニアより優秀です。

逆説的ですが、優秀なエンジニアほど資料や情報をきちんと残します。

OSSプロジェクトでも優秀なエンジニア達が積極的にドキュメントを整備しています。

個人的な見解ですが、「ドキュメント」を整備しないエンジニアとは仕事をしにくいですし、尊敬できる対象ではありません。

最後に

みなさんの現場でもドキュメントを作成しないエンジニアはいるでしょうか。

もしきちんと、設計書、パラメータシート、結線図、ER図などを作成していれば、それは紛れもなく正しい現場です。

ドキュメント整備は確かに面倒で退屈で時間がかかります。

しかし、それによって他のエンジニアであったり後の世代の仕事がしやすくなります。

1人でブラックボックスにするのは、他人を遠ざける原因です。

設計書もなく本番環境しかないシステムでいきなり作業したいエンジニアなんて多くはいません。

泥臭い仕事ですが、きちんとやって行く事で1流に近いづいていけるでしょう。

スポンサーリンク

フォローする

合わせて読んでみる

良ければ他の記事もどうぞ!



スポンサーリンク
コメントの入力は終了しました。