XEROTTA

新入社員の学び / IT初級者 / 講座17

IT FOUNDATION / COURSE 17

要件整理・設計・技術文書

要望を検証できる仕様へ変え、初めて担当する人も再現できる構築・運用手順書を書く。

アニメと具体例手順付き演習成果物とレビュー解説付き確認問題

まずは、図でつかもう

1 / 4

矢印を追い、各ポイントを押して確認しましょう。

01 / IT FOUNDATION

この講座で、何をできるようにするか。

要望を検証できる仕様へ変え、初めて担当する人も再現できる構築・運用手順書を書く。

目安12時間。説明・調査・演習・成果物作成・レビューを含む学習計画です。本文を読むだけでこの時間の実習を完了したことにはなりません。進み方と経験に応じて調整します。

学習目標と確認ポイント詳しく見る
  • 聞き取りと業務の目的を説明し、聞き取り票を作る。
  • 機能要件と非機能要件を説明し、要件一覧と受け入れ条件を作る。
  • 構成・データ・APIの設計を説明し、設計間の対応表を作る。
  • 手順書の前提と操作を説明し、構築・実行手順書を作る。
  • 調査記録と技術的な報告を説明し、調査報告を作る。
  • 第三者レビューと更新を説明し、レビュー済み手順書を作る。
開始前の準備

ブラウザーで本文・アニメ・問題を確認できます。実機演習は会社が用意した学習環境を使い、Python・Linux・Git・DB等の準備状況を確認してから進めます。

演習ファイルを先に準備する

Python・SQL・ログ・架空パケット表・テスト・APIのスターターと説明書を同梱しています。APIは認証・認可等を受講者が追加する未完成の学習用で、公開用完成品ではありません。

共通演習キットをダウンロード
要件整理・設計・技術文書の学習内容を表した仕組みのイメージ図

02 / IT FOUNDATION

仕組みを理解し、手を動かして確かめる。

1. 聞き取りと業務の目的2. 機能要件と非機能要件3. 構成・データ・APIの設計4. 手順書の前提と操作5. 調査記録と技術的な報告6. 第三者レビューと更新

聞き取りと業務の目的

詳しく見る

学習ブロック 1 / 目安2時間(説明・調査・演習・記録・レビュー)

利用者が求めた機能だけでなく、何の不便を解決したいか、現在どうしているかを聞きます。事実、要望、仮説を分け、前提と制約を明記します。解決案を早く固定しすぎず、確認する問いを準備します。

具体例と実習手順

「予約を便利にしたい」を、誰、いつ、どの作業、困る理由、成功の目安へ分解する。

残す成果物:聞き取り票

前提・操作・観察結果・理由・未確認を分けて残します。手順を他の人に説明し、同じ入力で同じ結果になるか確認してください。

機能要件と非機能要件

詳しく見る

学習ブロック 2 / 目安2時間(説明・調査・演習・記録・レビュー)

予約作成や取消等の機能と、性能、可用性、安全性、運用、利用しやすさ等の条件を分けます。「速い」「安全」とだけ書かず、対象条件と確認方法を明確にします。実現可能性と優先順位も関係者で確認します。

具体例と実習手順

予約の上限、重複時の扱い、想定利用者数、復旧条件を測れる表現へ変える。

残す成果物:要件一覧と受け入れ条件

前提・操作・観察結果・理由・未確認を分けて残します。手順を他の人に説明し、同じ入力で同じ結果になるか確認してください。

構成・データ・APIの設計

詳しく見る

学習ブロック 3 / 目安2時間(説明・調査・演習・記録・レビュー)

一枚の図だけで全てを説明せず、構成図、ER図、API仕様、画面の状態を目的で分けます。各資料で同じ項目や名前を使い、認証、認可、保存、エラーの境界を一致させます。未確定事項も明示します。

具体例と実習手順

予約作成を選び、画面入力、API、DB列、エラー文の対応を1行ずつ確認する。

残す成果物:設計間の対応表

前提・操作・観察結果・理由・未確認を分けて残します。手順を他の人に説明し、同じ入力で同じ結果になるか確認してください。

手順書の前提と操作

詳しく見る

学習ブロック 4 / 目安2時間(説明・調査・演習・記録・レビュー)

対象環境、バージョン、権限、必要なファイル、開始位置を示します。コマンドの貼り付けだけでなく、目的、期待する結果、失敗したとき止める条件を書きます。値を置き換える箇所を明確にし、秘密値を文書へ固定しません。

具体例と実習手順

キットの実行を、展開から環境確認、実行、結果、終了まで順に文書化する。

残す成果物:構築・実行手順書

前提・操作・観察結果・理由・未確認を分けて残します。手順を他の人に説明し、同じ入力で同じ結果になるか確認してください。

調査記録と技術的な報告

詳しく見る

学習ブロック 5 / 目安2時間(説明・調査・演習・記録・レビュー)

調べた問い、対象、方法、時刻、結果、解釈、未確認、出典を分けます。最初に結論と影響を示し、根拠を追える形にします。大量の画面写真だけでは、どの条件で何が分かったかを読めない場合があります。

具体例と実習手順

DNSとAPIの調査を題材に、事実と推測を分けた一ページの報告を書く。

残す成果物:調査報告

前提・操作・観察結果・理由・未確認を分けて残します。手順を他の人に説明し、同じ入力で同じ結果になるか確認してください。

第三者レビューと更新

詳しく見る

学習ブロック 6 / 目安2時間(説明・調査・演習・記録・レビュー)

自分の環境では通る手順でも、他の人が同じ前提を持つとは限りません。初見の人に再現してもらい、迷った箇所を直します。仕様変更に合わせて文書の所有者、更新理由、確認日も管理します。

具体例と実習手順

相手と手順書を交換し、口頭補足なしで実行できるか確認して修正履歴を残す。

残す成果物:レビュー済み手順書

前提・操作・観察結果・理由・未確認を分けて残します。手順を他の人に説明し、同じ入力で同じ結果になるか確認してください。

再現できる手順書の最小セット

目的:何を確認する手順か
前提:OS、バージョン、権限、必要ファイル
開始位置:どのフォルダーからか
操作:コマンドや画面操作と置き換える値
期待:どの表示・件数なら成功か
失敗時:どの条件で止め、何を記録するか
終了・戻し方:停止、残るデータ、復元方法
確認:第三者が口頭補足なしで再現できたか

03 / IT FOUNDATION

仕事のアニメ:要件整理・設計・技術文書を考える。

新人・アオイさんと先輩・ミナトさんの会話で、「要件整理・設計・技術文書」を学びます。最初の場面は「利用者が求めた機能だけでなく、何の不便を解決したいか、現在どうしているかを聞きます。」。何を確かめ、どう対応するかを順に見ていきましょう。

聞き取りと業務の目的1 / 6
アオイ

利用者が求めた機能だけでなく、何の不便を解決したいか、現在どうしているかを聞きます。

学習ポイント:聞き取り票

約12秒ごとに場面が切り替わります。再生中も一時停止でき、「前へ」「次へ」で自分のペースで読めます。最終場面で停止します。

アニメの内容をまとめて文章で読む

1. 聞き取りと業務の目的

アオイ:利用者が求めた機能だけでなく、何の不便を解決したいか、現在どうしているかを聞きます。

学習ポイント:聞き取り票

2. 機能要件と非機能要件

ミナト:予約作成や取消等の機能と、性能、可用性、安全性、運用、利用しやすさ等の条件を分けます。

学習ポイント:要件一覧と受け入れ条件

3. 構成・データ・APIの設計

アオイ:一枚の図だけで全てを説明せず、構成図、ER図、API仕様、画面の状態を目的で分けます。

学習ポイント:設計間の対応表

4. 手順書の前提と操作

ミナト:対象環境、バージョン、権限、必要なファイル、開始位置を示します。

学習ポイント:構築・実行手順書

5. 調査記録と技術的な報告

アオイ:調べた問い、対象、方法、時刻、結果、解釈、未確認、出典を分けます。

学習ポイント:調査報告

6. 第三者レビューと更新

ミナト:自分の環境では通る手順でも、他の人が同じ前提を持つとは限りません。

学習ポイント:レビュー済み手順書

04 / IT FOUNDATION

演習を完成させ、成果物をレビューする。

演習1

利用者の要望から機能・非機能・受け入れ条件を整理する。

  1. 対象・環境・入力データ・期待結果を記録する。
  2. 上の解説と各ブロックの実習手順を使って作業する。
  3. 結果を期待と比較し、違いがあれば条件を一つずつ確かめる。
  4. 成果物・再現手順・分かったこと・未確認を残してレビューする。

演習2

構成図・API・データの名前と境界を対応させる。

  1. 対象・環境・入力データ・期待結果を記録する。
  2. 上の解説と各ブロックの実習手順を使って作業する。
  3. 結果を期待と比較し、違いがあれば条件を一つずつ確かめる。
  4. 成果物・再現手順・分かったこと・未確認を残してレビューする。

演習3

他の人が再現できる手順と、根拠付きの技術報告を仕上げる。

  1. 対象・環境・入力データ・期待結果を記録する。
  2. 上の解説と各ブロックの実習手順を使って作業する。
  3. 結果を期待と比較し、違いがあれば条件を一つずつ確かめる。
  4. 成果物・再現手順・分かったこと・未確認を残してレビューする。
レビューで確かめること

正しい用語で説明できるか/入力と結果が対応しているか/正常だけでなく失敗する条件も扱ったか/他の人が再現できるか/残る課題を隠していないか。

05 / IT FOUNDATION

確認問題:答えより、理由を説明する。

全5問。選ぶと解説が表示されます。何度でも選び直せます。

回答済み 0 / 5問

06 / IT FOUNDATION

成果物を残し、理解と未確認を分ける。

架空データを使い、根拠と結果を自分の言葉でまとめます。回答とメモは自動保存・外部送信しません。残したい内容はコピーするか、成果物ファイルへ記入してください。

07 / IT FOUNDATION

説明・実装・記録を、一つの成果へつなげる。

要望を検証できる仕様へ変え、初めて担当する人も再現できる構築・運用手順書を書く。

  • 聞き取り票
  • 要件一覧と受け入れ条件
  • 設計間の対応表
  • 構築・実行手順書
  • 調査報告
  • レビュー済み手順書

08 / IT FOUNDATION

公式資料・確認先