office-933306_1920

システム開発におけるドキュメント

システムを構築する際には、各種設計書や管理資料など、さまざまなドキュメントを作成しながら作業を進めていきます。
主なドキュメントと、その作成時期、作成方法などをご説明します。

システムの内容に関するドキュメント

図書名 作成時期 内容
要件定義書 見積前または概算見積後 依頼企業側の要望をヒアリングする形で、開発業者が作成します。
システム化の目的、要求、課題内容を整理した上で、実現するための方法、作成する機能、見積と共に提示されます。
[clink url=”http://blog.tact-info.co.jp/blog/archives/product/%E8%A6%81%E4%BB%B6%E5%AE%9A%E7%BE%A9%E6%9B%B8″]
基本(外部)設計書 設計段階 要件定義書に基づき、具体的な画面レイアウトや帳票フォーマット、管理する項目などを定義したドキュメントになります。開発業者が作成し、操作方法などの説明を交えながら、実際の運用で使用する場面と合わせて内容を確認していきます。
[clink url=”http://blog.tact-info.co.jp/blog/archives/product/%E5%9F%BA%E6%9C%AC%E8%A8%AD%E8%A8%88%EF%BC%88%E5%A4%96%E9%83%A8%E8%A8%AD%E8%A8%88%EF%BC%89%E3%81%A8%E3%81%AF”]
詳細(内部)設計書 設計段階 基本設計の内容をより細分化し、その処理の内容をプログラム化しやすい方法でまとめたものが詳細設計書です。基本的にはシステム開発業者の内部的な作業のためのドキュメントになりますので、依頼企業側での内容の確認(レビュー)などはあまり行いません。
システム部門が自社にあり、保守などを担当する場合、まれに作り方までレビューの対象となる場合があります。
単体テスト仕様書/成績書 テスト段階 本ドキュメントも、多くの場合システム開発業者の内部ドキュメントになります。設計したプログラムが個々の単位で正常に動作しているかどうかをチェックするためのチェック表なものです。
結合テスト仕様書/成績書 テスト段階 本ドキュメントも、多くの場合システム開発業者の内部ドキュメントになります。ある程度の業務単位に、切り分けてテストをします。
パッケージとの連携や既存システムとの連携などがある場合は、この段階でテストをします。
総合テスト仕様書/成績書 運用開始前 運用を想定し、できるだけ実業務に近い形でテストを行います。作成はシステム開発業者が行いますが、その内容については、依頼企業側の確認をとりながら(実際の業務にあっているかなどを運用マニュアルと比較しながら)進めます。
本、テストの成績をもって、システム切り替えの判定を行いますので、その結果についても依頼企業との確認事項になります

会議・打合せ時に作成するドキュメント

図書名 作成時期 内容
議事録 打合せ時 要件定義や各種ドキュメントのレビューなどの打合せ内容を議事録として作成します。
通常、システム開発業者が作成し、依頼企業側が承認(確認)する形式で進めます。
課題管理表 打合せ時 打合せ時に発生した課題・問題点を一覧表に纏めたもので、議事録と一緒に管理・運用します。
毎回、会議の冒頭で「前回議事録の確認」および、「課題管理表」の進捗を確認し、残として残っている課題を消化していきます。

スケジュール・工程に関するドキュメント

図書名 作成時期 内容
WBS(Work Breakdown Structure) 要件定義後、都度 プロジェクト全体の作業(タスク)を洗い出し、その順番やそれぞれのスケジュールを記載した資料です。システム開発業者が作成します。最近では依頼企業と共有し、お互いのタスクを確認したり、遅れが今後どのように影響するかなどの検討資料として使用されます。
工程表 要件定義後、都度 WBSより、少し荒いおおまかな工程で作成されることが多いスケジュール管理表です。設計/製造/テストなど、制作ドキュメントやプログラミングの期間を中心に、予定を記載し、定例会などで実績を記したものを双方で確認するための表です。

納品ドキュメント

図書名 作成時期 内容
操作説明書 テスト完了時/運用開始前 システムの操作マニュアルです。画面ごとに入力する内容や、手順などを記載します。機能画面上からHELPファイルと呼ばれる操作方法を記載した画面を表示する形式で提供される場合もあります。
運用マニュアル テスト完了時/運用開始前 通常の業務の流れ(手順)に沿って作成されるマニュアルです。システムを使っての作業以外に、マニュアル作業などを含み、一連の業務が遂行できるように作成します。システム開発業者と依頼企業の双方で協力しながら作成します。
The following two tabs change content below.

田邉弘美(たなべひろみ)

メーカーのプログラマーを経て27歳で独立起業。数々多くの企業のシステム構築を手掛けてきました。得意な分野は基幹システムや営業支援、顧客管理など社内業務のシステム構築。プロジェクトでは、主にお客様の要望整理や業務改善などのコンサル部分を担当。私の無理難題も難なくこなす頼もしいスタッフ(技術者)に囲まれ、奮闘の毎日を送っています。

最新記事 by 田邉弘美(たなべひろみ) (全て見る)