このページの本文へ

サンプルで見るシステム開発ドキュメントの作り方

2013年10月17日 11時00分更新

文●水野良昭/オンラインデスクトップ

  • この記事をはてなブックマークに追加
本文印刷
web-keyword

 システムドキュメントとは、Webシステムを構築・運用するために必要な情報をまとめた文書のことです。具体的には、「システム仕様書」や「システム設計書」、「運用計画書」などを指します。

 システムドキュメントの目的は、クライアント側と開発側双方の認識を一致させることにあります。また、仕様書や設計書であれば開発チームの情報共有、納品後の運用・改修のための引き継ぎ資料としても使用します。

 実際の案件では、単独で利用する大規模なWebシステムと、Webサイトの一部に組み込む簡易的なWebシステムでは必要なドキュメントが異なりますので、それぞれのケースを説明しましょう。

単独で利用する大規模なWebシステムの場合

 個人情報を含む会員管理や、課金・クレジット決済などを含む大規模なWebシステムの場合は、Webシステムの構築前、一次納品時、運用前にそれぞれ異なるドキュメントを求められる場合があります。

 たとえば、Webシステムの構築前には「システム仕様書」に加えて、画面遷移やシステムフローなどをまとめた「システム設計書」、一次納品時にはテスト項目を記した「テストスペック」や「テスト結果報告書」、運用前にはトラブル時の連絡方法などをまとめた「システム運用計画書」、操作マニュアルなども必要です。

Webサイトの一部に組み込む簡易的なWebシステムの場合

 Webサイトの一部を更新するような簡易的なWebシステムの場合は、サイト制作時の企画提案書をブラッシュアップしてドキュメント代わりとすることが多くあります。こうしたケースでは、画面イメージ、画面遷移などが仕様書や設計書の役割を果たします。

 簡易Webシステムの場合も、本格的な運用が開始する時点で、運用に関してのマニュアルを作成します。マニュアルには、対応OS、対応ブラウザーなどの動作環境やシステム構成図、ログイン情報、ログイン方法などの手順を記載します。画面のスクリーンショットがあるとより分かりやすく、成果物としても残ります。

システムドキュメントは誰が作成するのか

 実際にどのようなドキュメントが必要かは、案件やクライアントによって異なりますので、Webディレクターはどのようなドキュメントを必要としているかを、クライアントから事前に確認しておく必要があります。システムドキュメントは技術的な内容が大半を占めるため、Webディレクターではなく、テクニカルディレクターやSE、プログラマーなどが中心となって作成しますが、滞りなく作成できるように、プロジェクトの進捗と合わせて管理するようにしましょう。

著者:水野良昭

JWDA(一般社団法人日本ウェブデザイナーズ協会)理事。1968年東京都生まれ。商社7年勤務後、シリコンバレーに渡米。帰国後、自治体WEBサイトを構築。その後ISPにてグループウェアASP商品化。第13回 KSPベンチャー・ビジネススクール 準優秀賞受賞。同ビジネスプランにて、オンラインデスクトップ株式会社を設立。

書影

書籍版は、企画・設計・制作・運用など、Webディレクション業務の大まかな流れに沿って構成。最新情報を盛り込み、書き下ろしのコラムや用語集も収録しました。ずっしり重い1030g、厚さ19.5mmで、苦手分野を穴埋めしたい新米Webディレクターや、これからWebディレクターを目指す方におすすめの1冊です。

Webディレクション標準スキル152

本体 4,280円+税、AB判392ページ(オール4色刷)
ISBN:978-4-04-868746-1

Amazon.co.jpで買う 楽天ブックスで買う

この連載の記事

一覧へ
Web Professionalトップページバナー

この記事の編集者は以下の記事をオススメしています

Webディレクター江口明日香が行く