設計書のテンプレート・サンプル|Excel・Markdownの使い分け

設計書のテンプレートとサンプルの使い分けを解説する記事のアイキャッチ。表の画面と構成図の紙が並ぶ机

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

設計書を書くことになって、まずテンプレートを探してみたものの、形式がばらばらでどれを使えばいいか迷っている。そんな方も多いはずです。

結論から言うと、設計書のテンプレートは「表で書く部分」「文章で書く部分」「図で描く部分」に分けて考えると選びやすくなります。表が多ければExcel、文章が多ければWordやMarkdown、という使い分けが基本です。

この記事を読めば、設計書のフォーマットの選び方と、種類ごとの記入例が分かります。

目次

設計書のテンプレート・フォーマットはどう選ぶ?

先に結論

社内に決まった形式があれば、それがいちばんのテンプレートです。無い場合は、設計書の中身が表中心か文章中心かで、ExcelかWordかMarkdownかを選びましょう。

『ネットで見つけたテンプレートをそのまま使っていいの?』と迷いますよね。テンプレートは便利ですが、自分のプロジェクトに要らない欄まで入っていることも多いんです。

まずは社内の過去の設計書を探してみてください。同じ形式でそろっていると、読む人も保守する人も迷わずに済みます。

Excel・Word・Markdownの使い分け

ソフトウェアの設計書のテンプレートは、主にこの3つの形式で作られます。編集部で向き・不向きを並べてみました。

形式向いている設計書気をつけたいこと
Excel画面の項目一覧、テーブル定義、入出力の一覧など表が中心の物長い説明文が読みにくい、変更の履歴が追いにくい
Word処理の説明や方針など文章が中心の物、発注側に渡す物表の並べ替えや集計がしにくい
Markdownプログラムと一緒に管理したい物、チームで少しずつ直す物表計算のような集計や複雑な表は苦手

Markdownで書く方法は仕様書・設計書をMarkdownで書く、作成ツール全般は仕様書の作成ツールで紹介しています。

設計書の表紙に入れる項目

設計書の表紙は、どの形式でもほぼ同じ項目で作れます。表紙だけ見て「何の文書の、どの版か」が分かれば十分です。

設計書の表紙に入れる項目
  • システム名と文書名(例:備品貸出システム 基本設計書)
  • 版の番号と作成日、更新日
  • 作成者と承認者の欄
  • 変更履歴(表紙の次のページでもよい)

変更履歴は、表紙の次のページに表で置くのがおすすめです。編集部が作った架空の記入例を載せますね。

版更新日変えた所変えた理由更新した人
1.04月10日初めて作成なし設計担当
1.14月24日G03の返す日の決まりを追加打ち合わせで決まったため設計担当
1.25月8日貸出票の項目に社員番号を追加総務からの依頼設計担当

「変えた理由」の欄があると、あとから読む人が『なぜここが変わったの?』と迷わずに済みます。版の付け方は仕様書の変更管理でくわしく紹介しています。

テンプレートを「表・文章・図」の3つに分けて考える

ここでの結論

設計書の中身は、表で書く部分、文章で書く部分、図で描く部分の3つに分けられます。どの部分が多いかで形式を選び、1冊の中で使い分けるのがコツです。

『設計書をExcelで作るか、それ以外で作るか』で迷う方は多いはずです。実は、1冊の設計書の中でも、表が向く所と文章が向く所が混ざっているんです。

設計書のテンプレートを表で書く部分・文章で書く部分・図で描く部分の3つに分けた整理表の図解

3つの部分の整理表

次の表は、編集部が設計書によく出てくる中身を、書き方で3つに分けたものです。

書き方向いている中身形式の目安
表で書く部分画面の項目一覧、テーブル定義、入出力の項目、メッセージ一覧、IPアドレスの割り当てExcel、Markdownの表
文章で書く部分設計の方針、決めた理由、処理の流れの説明、未決事項Word、Markdown
図で描く部分画面遷移図、システム構成図、ネットワーク構成図、処理の流れ図作図ツールで描いて貼る

例えば、画面設計書なら「項目一覧」は表、「この画面の目的」は文章、「画面遷移」は図、と分かれます。全部をExcelのセルに押し込もうとすると、文章の部分が読みにくくなりがちです。

Excelで全部作る職場も多い

社内の決まりでExcelにまとめる職場もたくさんあります。その場合も、文章の部分は1シートにまとめ、図は画像で貼るなど、3つを意識して分けると読みやすくなります。

設計書の種類別のサンプル(記入例)

ここでの結論

ここでは、画面設計書、入出力設計書、クエリの設計書、ネットワーク設計書の記入例を紹介します。どれも編集部が作った架空のサンプルで、社内の備品を貸し出すシステムを例にしています。

『実際にどう埋めればいいのか見てみたい』という方のために、表で書く部分を中心にサンプルを並べますね。自分のプロジェクトに合わせて欄を足したり減らしたりしてみてください。

画面設計書のテンプレート(項目一覧)

画面設計書のテンプレートでいちばん使うのが、画面ごとの項目一覧です。

項目名種類必須桁数決まりごと
借りる日日付の入力必須なし今日より前は選べない
返す日日付の入力必須なし借りる日より前は選べない
使う目的文字の入力任意100改行は使えない
申込ボタンボタンなしなし押すと入力チェックを行う

画面のレイアウトと画面遷移図は、作図ツールで描いて別の欄に貼ります。くわしくは画面設計書・画面仕様書の書き方で紹介しています。

入出力設計書のサンプル

入出力設計書は、ファイルや帳票など、システムに出し入れするデータの形を決める文書です。

入出力名区分形式主な項目タイミング
備品の一覧入力CSV備品番号、備品名、分類月に1回取り込む
貸出の記録出力CSV申込番号、備品番号、借りる日、返す日毎日夜にまとめて出す
貸出票出力帳票社員名、備品名、返す日承認された時

クエリの設計書のサンプル

データベースからデータを取る処理(クエリ)の設計書では、「何を、どこから、どの条件で、どの順に」を表にします。

欄記入例
目的指定した期間に貸し出し中の備品を探す
取る項目備品番号、備品名、借りている社員名、返す日
元のテーブル備品、貸出、社員
条件貸出の状態が「貸出中」で、期間が指定した日と重なる物
並び順返す日の早い順

テーブル側の書き方はテーブル定義書・データベース設計書の書き方で紹介しています。

ネットワーク設計書のサンプルとテンプレート

ネットワーク設計書は、構成図(図で描く部分)と、機器やアドレスの一覧(表で書く部分)の組み合わせで作ることが多いです。

機器の役割置き場所割り当てるアドレスの範囲つながる先
貸出システムのサーバー社内のサーバー室サーバー用の範囲社内のネットワーク
社員のパソコン各フロア社員用の範囲社内のネットワーク
外との出入口の機器サーバー室外向けの範囲社外の回線

アドレスの具体的な値や設定値は、構築のあとに作る設定の一覧で管理することもあります。テンプレートを作る時は、構成図の欄と一覧表の欄を分けておくと使いやすくなります。

設計書のテンプレートでよくある相談

ここでの結論

よく読まれている相談は「インフラの設計書の書き方」「Excelで設計書を作るのはよくないのか」「サイトマップの書き方」の3つです。どれも、表・文章・図のどれで書くかを考えると答えが見えてきます。

知恵袋に寄せられた相談の中から、閲覧の多いものを要約してお答えしますね。

相談1:サーバーの基本設計書・詳細設計書はどう書く?

『サーバーなどインフラの基本設計書と詳細設計書の書き方を教えてほしい』という相談です。

インフラの設計書では、基本設計書に「どういう方針で作るか」を文章と構成図で書き、詳細設計書に「どの機器にどの値を設定するか」を表で書く形が多いです。厚生労働省の職業情報提供サイト job tag(2025年時点の掲載)では、基盤システムのSEが設計の工程で作る設計書の主な内容を「機能、構成、性能、信頼性、予算、開発工程」としています。

相談2:Excelで設計書を作るのはよくない?

『Excelで設計書を作ることに否定的な人が多いけれど、どうなの?』という相談です。

Excelは表で書く部分にはとても向いています。一方で、文章が長い部分や、変更の履歴を細かく追いたい部分には向いていないこともあります。

どちらが正しいというより、中身に合った形式を選ぶのが大事です。3つの部分の整理表を見ながら、職場の決まりと相談してみてください。

Excelで作る場合は、シートの分け方を決めておくと読みやすくなります。例えば画面設計書なら、こんな分け方です。

シート書く中身3つの部分
表紙・変更履歴文書名、版、変えた所表
画面の目的この画面で何をするか、決めた理由文章
レイアウト画面の下書きの画像図
項目一覧項目名、必須、桁数、決まりごと表

相談3:設計書に載せるサイトマップの書き方は?

『企画書や設計書に載せるサイトマップの書き方やテンプレートを知りたい』という相談です。

サイトマップは「図で描く部分」にあたります。ページを箱で描いて、親子の関係を線でつなぐ形が分かりやすいです。

そのうえで、ページの一覧を表にして添えると、抜けがないかを確かめやすくなります。Webサイトの仕様のまとめ方はWebサイト制作の仕様書・要件定義書で紹介しています。

テンプレートを使い始める手順

ここでの結論

テンプレートは、使う前に「要らない欄を消す」「足りない欄を足す」のひと手間をかけると、ぐっと使いやすくなります。書き方そのもののコツは別の記事で紹介しています。

『テンプレートをもらったけど、どこから埋めればいいの?』という方は、次の順番で進めてみてください。

設計書のテンプレートを使い始める手順を、過去の設計書を探す所から先輩に見てもらう所まで順に並べた図解
設計書のテンプレートを使い始める手順
  1. 社内の過去の設計書があれば、それを元にする
  2. 中身を表・文章・図の3つに分けて、形式を決める
  3. 自分のプロジェクトで要らない欄を消す
  4. 表紙と変更履歴の欄を作る
  5. 1画面分や1処理分だけ書いて、先輩に形を見てもらう

書き方のコツは設計書の書き方|読み手に伝わる構成と表現のコツ、仕様書全般のひな形は仕様書のテンプレートで紹介しています。

設計書の形を整える力は、要件定義や設計といった上流工程を任される職場で評価されやすい力です。今の担当工程から一歩進みたい方は、求人の仕事内容を比べてみると道が見えてきます。今の職場で経験を積む道も、もちろんありです。

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

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

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

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

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

よくある質問

設計書のテンプレートはExcelとWordのどちらがいいですか?

中身で選ぶのがおすすめです。画面の項目一覧やテーブル定義など表が中心ならExcel、設計の方針や処理の説明など文章が中心ならWordやMarkdownが向いています。社内に決まった形式があれば、それに合わせましょう。

設計書のサンプルをそのまま使ってもいいですか?

形の参考にするのはよいですが、そのまま使うと要らない欄が残ったり、必要な欄が足りなかったりします。自分のプロジェクトに合わせて欄を整えてから使ってみてください。

設計書の表紙には何を書けばいいですか?

システム名と文書名、版の番号、作成日と更新日、作成者と承認者の欄を入れるのが一般的です。変更履歴を表紙の次のページに置くと、どこが変わったかを追いやすくなります。

Excel以外で設計書を作る方法はありますか?

WordやMarkdownで作る方法があります。Markdownはテキストで書けるので、プログラムと一緒に履歴を管理したい時に向いています。図は作図ツールで描いて貼り付けるのが一般的です。

まとめ

この記事の要点
  • 社内に決まった形式があれば、それがいちばんのテンプレート
  • 設計書の中身は「表で書く部分」「文章で書く部分」「図で描く部分」に分けて考える
  • 表が中心ならExcel、文章が中心ならWordやMarkdownが向いている
  • 画面・入出力・クエリ・ネットワークの設計書は、表の欄を決めておくと書きやすい
  • テンプレートは要らない欄を消してから使う
仕様書ドットコム

仕様書ドットコム 編集部

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

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

コメント

コメントする

目次