ドキュメントは必要?SEに社内転職した実体験と一緒に語ります

あなたはプログラムを書く時に、仕様書等のドキュメントを作っていますか？
もしかして、いきなりプログラムを書いてしまっていませんか？

私も以前はいきなりプログラムを書いてしまっていましたが、現在は残すようにしています。
中小企業の社内SEに転職してから、特にありがたみを感じることが増えてきました。

ドキュメントについていまいち意味を見出せない方は、是非参考にして下さいね!!

結論：ドキュメントは必要

結論から言うと、ドキュメントは必要です!!
私は社内転職で中小企業のシステム部署にいますが、これがなくて滅茶苦茶困っています!!

ドキュメントを一言で言うと、プログラムの取り扱い説明書だと思っています。
網羅的に辿るなら、こちらを参考にしてみて下さいね。

システム会社に依頼している案件は、システム会社がかなり細かく作成してくれますが小規模案件や自社開発、昔作った物などはかなり曖昧なのかな？と思ってます。

ここからは私がドキュメントがなくて、どんな所に困ったのか語らせてもらいます。
他にも、「こんな事に困った」という事があれば教えて下さい!!参考にします。

私は前任者の退社にともない、システム部署に移る事になりました。
異動後、引継ぎ資料を見ても、ソフト名と保存場所しか書いてありません。

おいおい、そりゃないぜ～

心象的にはこんな感じです。
現在ドキュメント作りに積極的に取り組んでいますが、ソフトを使っている人や製作依頼者を探すところからスタートしています。

本当に時間の無駄です。一行だけでもいいので、ざっくりとした説明を書いてほしかった…。
もしかしたら、本人も覚えていないのかもしれませんね。

プログラムの変更履歴が無いのも、困っています。
何も書かずにコメントアウトされていたら、私は「いつ、なぜこのプログラムをコメントアウトしたんだろう？」って考えてしまいます。

コメントもあったりなかったり…忙しかったんですかね？
いちいち確認し、時間がかかってしまいますね。

あなたは組織や部署が関わるプログラムを作成したことがありますか？
フォルダやファイルの場所、データベース等を変変わってしまうとプログラムが正常に動作しない原因になってしまいますね。

そう、組織変更等により発生する作業範囲が明確になっていないんです!!
部署名が変わったら修正の嵐…

システム部署に移る前から、個人的にトラブルが多いと思っていましたがこんな状況とは思っていませんでした。

現在私はトラブル対応等を除けば、ドキュメント制作を最優先に取り掛かるようにしています。
様式等は固まっていませんが、今後作りながら固めて水平展開したいと考えています。

今は、大雑把になってしまいますが重要そうな所から手を付けています。

正直これで十分かわかりませんが、改善点があればより良くしていきたいですね!!

社内転職した私が直面した「ドキュメントが無くて困った事」についてまとめてみました。

他の会社もこんなもんなのでしょうか？
私としては、少しでも改善できるように進めたいなとは思っています。

あなたも、後の人が困らないようドキュメントを作ってくれたらありがたいなと思います!!