設計書・仕様書のレビュー観点|見落としを防ぐチェックリスト

設計書や仕様書のレビュー観点とチェックリストを紹介する記事のアイキャッチ。付箋の貼られた設計書

当サイトの記事は編集部が国土交通省・IPA・デジタル庁などの公的機関の情報、規格や業界団体の公開情報を調べて独自に執筆しています。記事内にIT・Webエンジニアの転職サービスへの案内(広告)を含みます。

設計書のレビューを頼まれたものの、『どこを見ればいいの?』『的外れな指摘をしたらどうしよう』と不安になっていませんか。

結論から言うと、設計書のレビューは「抜け」「あいまい」「矛盾」「実現できるか」「テストできるか」の5つの観点で見ると、見落としがぐっと減ります。思いついた所から読むより、観点を決めて読むほうが早いんです。

この記事を読めば、仕様書や要件定義書にも使えるチェックリストと、レビューの進め方が分かります。

目次

設計書のレビューは何のためにする?

先に結論

レビューの目的は、作る前に誤りを見つけることです。設計書の段階で見つけた誤りは、作ってから見つかった誤りより直す手間がずっと少なく済みます。

設計書に誤りがあると、そのまま作られてテストで見つかり、設計から作り直すことになりますよね。レビューは、その手戻りを前で止めるための作業なんです。

IPAの「超上流から攻めるIT化の原理原則17ヶ条」には、「要件定義書はバイブルであり,事あらばここへ立ち返るもの」という条があります。立ち返る先の文書だからこそ、誤りや抜けを早いうちに見つけておきたいわけですね。

誰のためのレビュー?

レビューは書いた人を評価する場ではありません。設計書を読んで作る人、テストする人、使う人のために、文書をよくする作業です。そう考えると、指摘も出しやすくなりますよ。

5つの観点で見るレビュー観点チェックリスト

先に結論

設計書のレビュー観点は「抜け」「あいまい」「矛盾」「実現できるか」「テストできるか」の5つです。1回の読み込みで全部を見ず、観点ごとに読み直すと見落としが減ります。

ここが大事なところです。5つの観点を順番に当てていくと、どの設計書でも同じように見られます。

設計書のレビュー観点を抜け・あいまい・矛盾・実現できるか・テストできるかの5つに分けたチェックリストの図解
観点見る所よく見つかる例
抜け書かれているべき事が無いかエラーの時の動きが書かれていない
あいまい人によって読み方が変わらないか「速やかに」「適切に」など、どこまでか分からない言葉
矛盾文書の中や、ほかの文書と食い違っていないか画面の項目と、テーブルの列の桁が違う
実現できるか今の仕組みや期間で作れるか使っている仕組みでは対応していない動きを前提にしている
テストできるか合っているかを確かめる方法があるか「使いやすいこと」のように、合否を決められない書き方

観点1:抜け

まず、書かれているべき事が書かれているかを見ます。正常な動きだけでなく、入力が間違っていた時や、データが無い時の動きも書かれているか確かめましょう。

決まっていない事が「未定」と書かれているかも、抜けの観点で見ておきたい所です。デジタル庁のDS-100(デジタル・ガバメント推進標準ガイドライン)でも、未確定な要件はリスクになり得るので、その旨を要件定義書で明らかにするとしています。

観点2:あいまい

読む人によって受け取り方が変わる言葉が無いかを見ます。「十分に」「なるべく」「適宜」といった言葉は、具体的な条件に言い換えてもらいましょう。

例えばこんなやり取りです。

「検索結果は速やかに表示する、とありますが、何秒以内なら合格ですか?」
「そこはまだ決めていませんでした。発注側と相談して数字で書きます」

こうして聞くだけで、あいまいな所が「決める事」に変わります。

JIS Z 8301:2019(規格票の様式及び作成方法)では、要求事項は客観的に検証できるものだけを規定し、「十分に強い」のような表現を用いない、という原則が示されています。仕様書を書く時にも、そのまま使える考え方なんです。

観点3:矛盾

同じ設計書の中で、章によって書いてある事が違わないかを見ます。画面の設計とデータの設計のように、別の文書との食い違いも見逃しやすい所です。

矛盾を見つけるには、同じ項目を別の文書と並べて読むのが早道です。例えば画面の項目一覧とテーブル定義を横に並べ、名前・桁・必須かどうかを1行ずつ見比べてみてください。

観点4:実現できるか

書かれている事が、今の仕組みや期間、人手で作れるかを見ます。ここは作る側の経験が活きる観点なので、開発の担当者に入ってもらうと見つかりやすくなりますよ。

『作れるかどうかは作る人が判断すればいい』と思うかもしれません。でも、設計の段階で気づけば、要件を少し変えるだけで済むことも多いんです。

観点5:テストできるか

書かれた通りにできているかを、テストで確かめられるかを見ます。合否の基準が書けない仕様は、あとでテスト仕様書を作る時に困るんです。テストの書き方はテスト仕様書とは?で紹介しています。

設計書チェックリスト(5観点)
  • エラー時・データが無い時の動きまで書かれている
  • 未定の所が「未定」と書かれ、決める期限がある
  • 「適切に」「なるべく」などの言葉が残っていない
  • 章どうし、ほかの文書と項目や桁が食い違っていない
  • 今の仕組みと期間で作れる内容になっている
  • 合否を決められる書き方になっている

要件定義書のレビューはどこが違う?

先に結論

要件定義書のレビューは、技術より「業務と合っているか」を重く見ます。発注側の業務を知る人に入ってもらうのがポイントです。

要件定義書は、発注側と開発側が「何を作るか」を決める文書ですよね。だから、技術的に正しいかより、業務の困りごとが解決するかを先に見るんです。

文書重く見る観点入ってほしい人
要件定義書抜け、あいまい、業務と合っているか業務を知る発注側の担当、開発の責任者
基本設計書矛盾、画面や帳票が要件どおりか発注側の担当、開発の担当
詳細設計書実現できるか、テストできるか開発の担当、テストの担当

これは編集部が考えた目安です。要件定義書のレビューのチェックリストには、上の5観点に「業務の流れと合っているか」「非機能要件(性能やセキュリティなど)が書かれているか」を足しておくと安心ですよ。

要件定義書の中身は要件定義書とは?、設計書の種類は設計書とは?でまとめています。

作成者がレビューの前にしておくこと

レビューは、頼む側の準備で質が変わります。何も伝えずに「見てください」と渡すと、読む人はどこから手をつければいいか迷ってしまうんです。

レビューを頼む前のチェック
  • 見てほしい範囲(章や項目)を書いた
  • 特に見てほしい観点を書いた
  • 前の版から変えた所に目印を付けた
  • 参照する文書(要件定義書など)を添えた
  • 指摘を返してほしい期限を書いた

設計書のレビューのやり方と進め方

先に結論

レビューは「準備」「事前に読む」「会議で確かめる」「直して確かめる」の4段階で進めます。会議の場で初めて読むと、時間ばかりかかって見落としも増えます。

『レビュー会議って、読み上げながら進めればいいの?』と迷う方も多いはずです。読み上げは丁寧ですが、時間がかかるので、事前に読んでおく形と組み合わせるのがおすすめなんです。

設計書レビューの進め方
  1. 作成者が、見てほしい範囲と観点を書いて頼む
  2. レビュー担当が、事前に読んで指摘を書き出す
  3. 会議では、指摘の中身を確かめて直し方を決める
  4. 作成者が直し、変更履歴に記入する
  5. 指摘した人が、直った所を確かめて閉じる

指摘の書き方のコツ

指摘は「どこが」「何が問題か」「どうしてほしいか」の3点で書くと伝わります。

書き方例
伝わりにくい4章が分かりにくい
伝わりやすい4.2の「速やかに」は何秒以内か分からないので、時間で書いてほしい

「ここが変」だけだと、書いた人は何を直せばいいか迷ってしまいます。直してほしい形まで書いておくと、やり取りが1回で済みますよ。

よくある失敗

誤字や表記ゆれの指摘ばかりで、中身の指摘が無いまま終わってしまうことです。表記の指摘はまとめて1件にして、5つの観点の指摘に時間を使いましょう。

直したあとの版の付け方は、仕様書の変更管理で紹介しています。

設計書レビューのよくある相談

先に結論

よくあるのは「的外れな指摘ばかりしてしまう」「レビュー観点のリストが欲しい」「読み上げ型のやり方でいいの?」の3つです。観点を決めて読むことで、どれも解決に近づきます。

知恵袋などで見かける相談を、内容をまとめて紹介します。

相談1:周りと比べて的外れな指摘ばかりしてしまう

設計書のレビューで、周りの人と比べて的外れな指摘ばかり出してしまい、レビューする力をつけたい、という相談です。

的外れになる原因は、何のための設計書かをつかむ前に、細かい所から読んでしまうことが多いんです。まず要件定義書で目的を確かめてから、5つの観点の順に読んでみてください。

『この指摘、的外れかも』と思ったら、質問の形で出す方法もあります。「4.2はこういう意味で合っていますか」と聞けば、相手を責める形になりません。

相談2:レビュー観点のリストが欲しい

ソフトウェア開発のレビュー観点のリストが欲しい、どこかで公開されていないか、という相談です。

公開されている観点を参考にするのもいいですが、自分たちの開発でよく起きる誤りを足していくのが一番役に立ちます。この記事の5観点を土台にして、過去のレビューで多かった指摘を書き足していきましょう。

相談3:読み上げながら補足するやり方でいい?

設計書を読み上げて、その場で補足しながら進めるレビューのやり方でいいのか、という相談です。

読み上げは、作成者の考えが伝わりやすい良さがあります。ただ、聞く側が受け身になりやすいので、事前に読んで指摘を持ち寄る形と組み合わせると、見落としが減りますよ。

相談4:設計書は「です・ます」と「である」のどちらで書く?

プログラムの設計書は、です・ます調とである調のどちらがいいのか、という相談です。閲覧数が多く、レビューで指摘されて迷う人も多いようです。

どちらが正しいという決まりはありません。レビューでは、1つの設計書の中で文体がそろっているかを見れば十分です。職場に書き方の決まりがあれば、そちらに合わせましょう。

レビューする力は仕事でどう活きる?

先に結論

設計書を5つの観点で読み、伝わる指摘ができる力は、設計や要件定義を任される仕事で頼られる力です。

レビューは、人の書いた文書を読んで、誤りや抜けを見つける作業です。実は、自分で書くより多くの設計書に触れられるので、設計の力を伸ばす近道でもあるんです。

今の職場でレビュー担当を任せてもらい、経験を積むのも立派な道です。上流工程の仕事に進みたい人は、求人の仕事内容で「レビューや設計をどこまで任されるか」を比べてみると、次の一歩が見えてきますよ。

会議室の机に広げた設計書と付箋、指摘を書き込むペンを持つ手元とノートPC

IT・Webエンジニアの転職(PR)

仕様書を書く経験を活かせる職場を探すなら、求人も比べてみる

要件定義や設計を任されるか、発注側か開発側か、扱うシステムや働き方は会社によって大きく違います。担当したい工程や条件から、IT・Webエンジニアの求人を比べてみてください。

無料ITエンジニアの求人を探す

求人の条件・待遇は各求人票と応募先の案内でご確認ください。

よくある質問

設計書のレビュー観点には何がありますか?

この記事では「抜け」「あいまい」「矛盾」「実現できるか」「テストできるか」の5つに分けています。観点ごとに読み直すと、見落としが減ります。

仕様書のチェックリストはどう作ればいいですか?

5つの観点を土台にして、自分たちの開発でよく起きた誤りを項目として足していきます。使うたびに見直して、増やしたり減らしたりしましょう。

要件定義書のレビューで気をつけることは?

技術より、業務と合っているかを重く見ます。業務を知る発注側の担当に入ってもらい、非機能要件が書かれているかも確かめましょう。

設計書のレビューはどう進めればいいですか?

作成者が範囲と観点を書いて頼み、レビュー担当が事前に読んで指摘を書き出し、会議で直し方を決める流れがおすすめです。直したあとは、指摘した人が確かめて閉じます。

設計書の文体は「です・ます」と「である」のどちらがいいですか?

どちらでも構いませんが、1つの設計書の中ではそろえましょう。職場に決まりがあれば、それに合わせるのが一番です。

まとめ

この記事の要点
  • 設計書のレビューは作る前に誤りを見つけるための作業
  • 観点は抜け・あいまい・矛盾・実現できるか・テストできるかの5つ
  • 要件定義書は業務と合っているかを重く見る
  • 準備・事前に読む・会議で確かめる・直して確かめるの順で進める
  • 指摘は「どこが・何が問題か・どうしてほしいか」で書く
仕様書ドットコム

仕様書ドットコム 編集部

仕様書の意味・種類・書き方から、システム開発の要件定義書・設計書・テスト仕様書、公共工事の標準仕様書・共通仕様書、住宅や発注の仕様書、仕様書を書く仕事のキャリアまでを、初めて仕様書に向き合う人が自分で判断できるように整理している情報サイトです。 公式サイト

よかったらシェアしてね!
  • URLをコピーしました!
  • URLをコピーしました!

コメント

コメントする

目次