開発作業で大事なこと

2018/12/5 Wed

Read in 1 minutes

こんにちは、batapy88です。今日は「開発」と呼ばれる作業の中で、大事だな~って思うことを書いていきます。

「開発する」ときに大事だと思うこと

開発するときに大事だと思うこと、それは、ドキュメント類(要件定義書や仕様書、使い方説明の文書など)をしっかり書いておくことです。

これを怠ると、おおきなしっぺ返しがかえってきます。

私自身、ろくなドキュメント類が無いシステムの開発と保守にかかわったことがあります。

そのときはクライアントからの問い合わせやバグ報告、追加要望にまともに答えることができず、毎日が地獄(デスマーチ)でした。

一説には、良いプログラマー・システムエンジニアはソースコードと同じかそれ以上のドキュメント類を書くそうです。

ドキュメント類を書くことは、それくらい大事なことだということです。

それができない人は、自分のことを「プログラムが書ける」や「システム開発できる」と、軽々しく言ったり思ったりしないでほしいものです。

ドキュメント類を書いておくとどんないいことがあるか、ちょっと考えてみます。

  1. ユーザーやクライアントが使えるシステムになる

    これは容易に想像できます。

    ただ、このときはドキュメント類に書かれている文章の品質が大事になってきます。わかりやすい文章にすること、意味の取り違えが無い文章にすること、を実現しないと意味がありません。

  2. 保守や運用がしやすくなる

    開発を担当した人や会社が、保守や運用も担当することは稀だと思います。

    どんなシステムなのかわからなければ保守・運用を代行するのは容易ではありません。

    使用シーンで思っているとおりの結果にならないとき、あるいは思ってもいないことが起こってしまったとき、それがバグなのか仕様なのか、切り分け作業に多大な時間と労力がかかってしまいます。

  3. 継続的な改善に役立てられる

どんなシステムでも完璧ではありません。どこかに何かしら改善すべき点があります。

ましてや新しく作ったシステムを使い始めたときは、積み残しの機能やつぶし切れていないバグ、開発時には想定していなかった使われ方や使ってみて初めてわかる追加要望など、改善すべき点が山積みになるのが当たり前です。

ざっと3点あげてみました。

ほかにも細かく考えれば、ドキュメントを作っておいてよくなる点や楽になる点はたくさん見つかるはずです。

少なくとも、上記3点は実感として良い点かと思い書かせていただきました。

さあ、ドキュメントを書こう

もしあなたが、プログラマーやシステムエンジニアなら、

あるいはプログラマーやエンジニアを動かす側のディレクターやプランナーなら、

そして、「ドキュメント類を書いていないな~」と気づいているなら

いますぐ書きましょう、ドキュメントを!!

将来のあなたにとって、またあなたをとりまく環境にとって、そのドキュメントは必ず貴重な情報になります。

今日は、そんなことを思ったのでした。