はじめに
仕様書とは、どんな役割をする書類なんだろう?
そんな疑問をお持ちの方へ。
ソフトウェアやアプリの開発において作成する仕様書の種類やポイントをお伝えします。
目次:
1. 仕様書とは?
仕様書とは、作成するシステムにおいて満たすべき条件や実際の画面の設計、処理の動きなどを定めたものです。
仕様書の作成はプロジェクトにとってとても重要であり、成否を分けるといっても過言ではありません。
しっかり、顧客が求めている要件をもれなく相違がないように落とし込むことが肝要です。
仕様書はシステムという完成品がどうあるべきかというビジョンを示す役割を果たすもの。
顧客と、自社のエンジニア、プロジェクトマネージャーにとって共通認識となります。
開発において、スタート地点となるフェーズで
仕様書は旅行における下調べや、料理の食材の準備と同じです。
そのことを曖昧にすることで、後々手直しが増えて時間や手間が多くなってしまいます。
また、開発してから変更や修正が生じた場合に仕様書を手直しする必要があります。
また、仕様書と一緒に作成する書類に設計書という書類もあります。
設計書は開発を行う時の具体的な制作工程を表した資料です。
仕様書をもとに製作工程を落とし込んでいきます。
仕様書は何を作るかということを記すのに対して、設計書はどう作るかという過程を記すという意味合いの違いがあります。
2. 仕様書の種類
仕様書の種類についてお伝えします。
一口に仕様書と言っても、例えば製造業で商品を作成する時や建設業でも使われています。
それぞれ、製品の納入仕様書、購入仕様書または建築における建築工事仕様書などです。
今回は、システムやアプリ等の開発における仕様書についてお話しします。
開発をするときの主な仕様書の種類を説明と共に挙げていきます。
・要件仕様書(要件定義書)
クライアントが開発を希望するシステムに必要な機能や目標などです。
クライアントの要求を聞き取り、システムの機能、特性、特徴などを記します。
インターフェースやセキュリティ、品質保証というような業務要件も含みます。
システム開発において、一番最初に作成する仕様書となります。
契約を締結するために合意を行うための共通認識です。
作成するのはクライアント側となり、開発会社に分かりやすい表記をすることが肝要です。
・機能仕様書
クライアントから聞き取った要件をもとにシステムの開発をするにあたっての仕様をまとめます。
・概略
・要件
・性能
・データ仕様
・画面仕様
・操作手順
・テスト要件
などを定義する書類です。
ユーザーから見た視点でのシステムの操作や処理をしたときの様子をストーリー形式で記します。
後の開発をするための重要な情報となる書類です。
システムに関して、具体的に製品をどうするということを簡潔に表現したもの。
製品の開発について、経験のある人による作成が望ましいです。
クライアントの要求とのずれがないようにしっかり折り合わせることが肝要です。
分かりやすく、図表やフローチャートを利用するといいでしょう。
・技術仕様書(詳細設計書)
機能仕様書をもとに、機能を開発するための手法をまとめた書類です。
・データ構造の設計
・データベースの設計
・機能のアルゴリズム
・開発ツール
・入出力しよう
・画面設計
上記のような項目が主な内容です。
技術に関する専門的な内容となり、開発者でも関わる人の間で認識を統一するために用います。
技術仕様書は、設計をするための書類なので項目別に体系を整えて書くことがポイントです。
細かい仕様まで記載すると、分かりやすくて誤った認識になりません。
3. 仕様書の特徴
分かりやすい仕様書はどんなものなのでしょうか。
仕様書を作成するにあたって重要なポイントを挙げていきます。
・文章が分かりやすい、記述が明確
仕様書は相手からの要件などの情報を言葉に表したものです。
情報を漏れなく他人に分かりやすいような言葉で記述しなければいけません。
要件定義などは5W1Hに加えてHow much(いくらで),How many(いくつの)の二つを入れて5W3Hという言葉もあります。
・画面遷移図がしっかり定義されている
画面遷移図とは、ユーザーが最初の画面にアクセスしてからメニューの選択などによりたどる画面の移動を表した図です。
ユーザーの目線に立ってシステム全体を俯瞰することができます。
また、画面ごとに項目やボタン、通知メッセージなどの細かい説明を記述すると丁寧です。
・イラストが入っている
仕様書のような情報の多い文書においては、文字だけの説明では分かりにくく想像ができにくいです。
イラストやイメージ図が入っているとより分かりやすくなります。
実際の画面のラフなイメージなどを取り入れることで、誤認防止にもつながります。
ここで、PDF編集にお勧めのwondershare社のPDFエレメントについてお伝えします。
https://pdf.wondershare.jp/
上記のアドレスが製品のHPです。
PDFエレメントは、PC、スマホどちらでも利用できるソフトウェアです。
ビジネス、手紙、送付状などたくさんのジャンルのテンプレートが揃っています。
また、読み上げ、編集、電子署名、ページ編集、圧縮などの機能を搭載していて初心者でも無理なく利用できます。
仕様書のような複雑な書類を多媒体へ送付する場面でもPDFを利用すると体裁が崩れにくいのがいいところ。
他形式からの変換機能についても、エクセル、ワード、パワーポイントと多種類に対応しています。
クラウドサービスも提供していて、好きな時にファイルの編集ができるのも利点です。
会員登録はWEB上で氏名、クレジットカードの情報などを入力するだけで簡単にできます。
無料のコースもありますけど、利用できる機能が限られてきます。
是非、有料会員の登録をおすすめします。
4. 無料で仕様書のひな形・テンプレートをダウンロードできるサイト
無料で仕様書のひな形・テンプレートがダウンロードできるサイトをご紹介します。
参考にしてください。
・Smartsheetのホームページ
https://jp.smartsheet.com/free-technical-specification-templates
開発に関するテンプレートを提供しています。
・Bizoceanのホームページ
https://www.bizocean.jp/doc/detail/104799/
印刷物の仕様書です。
・業務効率ガイドのホームページ
https://www.stock-app.info/media/specification-templates/#Excel-2
要件仕様書、基本設計書など数種類から選択できます。
・Notionのホームページ
https://www.notion.so/ja-jp/templates/category/engineering-tech-spec
送付状、開発、経理など様々なジャンルのテンプレートがたくさんあります。
・ビズルートのホームページ
https://bizroute.net/nounyu_template.html
購入仕様書、納入仕様書のテンプレートです。
5. 仕様書に関するよくある質問
仕様書に関するよくある質問、回答をお伝えします。
・仕様書に入れるといい図はありますか?
仕様書は、データや画面の関係やシステムの全体像を表します。
そこでおすすめなのは、フローチャート、ガントチャート、ER図などです。
他にも、マインドマップやUML図なども利用してもいいですね。
専用の描画ソフトを利用すると作成がしやすくておすすめです。
仕様書の種類にあった図をお使い下さい。
・仕様変更が起きるケースはどんなものがありますか?
開発途中で変更が起きるのは以下のような場合です。
・クライアントとの認識違い
・内容の変更
・仕様書の内容の抜けがあった場合
・開発途中で仕様変更があった場合
まとめ
仕様書に関する記事を読んでいただきありがとうございました。
仕様書は、システム開発をする上でクライアントと開発者を結ぶ大事な書類です。
システムの内容を文章のみで表すだけでなく、図やイメージを利用することで分かりやすくなります。
クライアント、開発者、そしてエンドユーザーにとって使いやすいシステムを目指しましょう。
この記事を読んで、役立てていただければ幸いです。
役に立ちましたか?コメントしましょう!