COLUMN

お役立ち情報を
毎週お届け

  1. HOME
  2. ブログ
  3. コラム
  4. 御社にはシステムに関するドキュメントが揃っていますか?

御社にはシステムに関するドキュメントが揃っていますか?

あなたの会社には、システム開発会社から提供されたドキュメントがありますか?システムに限らず、ホームページを作成してもらった場合も同様です。
ドキュメントは何種類もあり、作成しない場合もありますが、必要性についてお話させていただきます。

1.なぜ、必要なのか

システムでも、ホームページでも、どんな物を作るのか、決めなければならないことが沢山あります。また、出来あがった後に「誰もわからないシステム(ホームページ)」とならない為にもドキュメントが必要です。

(1)意思疎通
「思っていた物と違う」とならないように、制作前から開発会社と認識合わせをしておく

(2)誰でも操作方法がわかる
「この人しか操作方法がわからない」とならないように、マニュアルがあると他の方でも操作できる

(3)システムの改修や別システムへの置き換え
もし、システムを作った人が退職してしまい、他の人(会社)へ改修や別システムへの置き換えをお願いする場合、ドキュメントがないと、エンジニアはソースを解読することになる

2.必要とされるドキュメント

当方の場合、要件をヒアリングし、サンプルで仕様(イメージ)を確認していくなどして、ドキュメントを省いている場合もありますが、一般的に必要とされるドキュメントは以下となります。

(1)RFP(提案依頼書)
クライアントが開発会社に、概要・目的・予算・要件などを提示する

(2)要件定義書
RFPやヒアリングを元に、要件・機能・課題などを開発会社がまとめる

(3)基本設計書
業務フロー、画面レイアウト、帳票レイアウトなどを開発会社が提示する

(4)詳細設計書
機能処理、フローチャート、データベース構成などを開発会社が作成する

(5)単体テスト仕様書・成績書
1つ1つのプログラムを単体でテストする

(6)結合テスト仕様書・成績書
複数のプログラムを組み合わせてテストする

(7)システムテスト仕様書・成績書
総合的にシステムを操作してテストする
この後、クライアントの環境で動作を検証する「運用テスト」を実施する場合もある

(8)操作説明書(運用マニュアル)

3.まとめ

開発工数よりもドキュメント作成の工数が多くなってしまったり、ドキュメント作成に別途費用を請求されてしまったりする場合もありますが、全体の構成や機能がわかるドキュメントや、誰でも操作がわかるドキュメントは必要最低限あると、自社内も開発会社も助かると思います。これは、属人化脱却に大きく繋がります。

ホームページでWordPressを利用し、プラグインを導入されている場合は、有効化しているプラグインの一覧を残しておいた方が良いでしょう。プラグインのバージョンアップにより、Webサイトが表示されなくなってしまい、原因を突き止めるために、全てのプラグインを無効化しなければならない事例もあります。原因を突き止め、悪さをしていないプラグインを再度有効化する時に迷わないようにしておくことも大切です。