第3部：ドキュメントスキル

設計書の読み方、技術ドキュメントの調べ方、報告書の書き方など、コードを書く以外の重要なスキルを学びます。エンジニアの仕事は、コードを書く時間よりもドキュメントを読み書きする時間の方が長いことも多いです。

📖 全7章対象：設計書・仕様書を読み書きする全ての方

この部の活用の仕方

この部を読む目的は、すべてを暗記することではありません。

最初に大事なのは、「開発現場ではどんなドキュメントが使われているのか」をざっくり把握することです。全体像を知っておくことで、実際の業務で「このドキュメントを読んでおいて」と言われたときに、「ああ、あれのことか」とスムーズに対応できます。

各ドキュメントの詳細な読み方は、実際にそのドキュメントを読む必要が出てきたときに該当ページを見ればOKです。

開発プロジェクトによって使うドキュメントは異なります。すべてのプロジェクトで全種類のドキュメントが使われるわけではありません。また、ドキュメントの読み方は実際に手を動かしながら覚えるのが最も効率的です。

この部で紹介するドキュメントは、多くの開発現場で一般的に使われているものです。

ただし、案件や現場によって以下のような違いがあります：

「このプロジェクトではどんなドキュメントがありますか？」「ドキュメントはどこに保管されていますか？」と確認しましょう。

章	対象ドキュメント	概要
第1章	設計書・仕様書の読み方	すべての設計書に共通する読み方の基本
第1章	技術ドキュメントの読み方	公式ドキュメント、APIリファレンスなどの調べ方
第1章	ドキュメントの書き方	報告書、議事録、手順書などの書き方
第2章	要件定義書	「何を作るか」「なぜ作るか」が書かれた最上流のドキュメント
第2章	基本設計書	システム全体の構成（外部仕様）を記載
第2章	詳細設計書	詳細な処理方法（内部仕様）を記載
第3章	画面設計書	画面レイアウト、入力項目、画面遷移を定義
第4章	処理設計書	各機能の処理内容・ロジックを記載
第4章	処理フロー図	処理の流れをフローチャートで表現
第4章	クラス図	クラス構造と関係性を図示（オブジェクト指向設計）
第4章	状態遷移図	データや画面の状態変化を図示
第5章	ER図	テーブル間の関係を図示
第5章	テーブル定義書	各テーブルのカラム定義、型、制約を記載
第6章	API仕様書	APIのエンドポイント、パラメータ、レスポンスを定義
第7章	試験仕様書	テストケース、期待結果、テスト手順を記載

ドキュメントを読まずにコードだけ見ればいいのでは？

コードだけでは「なぜそうなっているか」がわかりません。

コードには「何をしているか（How）」は書かれていますが、「なぜそうするのか（Why）」「どういう要件があるのか（What）」は書かれていません。ドキュメントを読むことで、コードの背景や意図を理解でき、適切な修正や機能追加ができるようになります。

ドキュメントが古い・間違っていることはないの？

あります。むしろよくあります。

残念ながら、ドキュメントが最新のコードと一致していないことは珍しくありません。だからこそ「ドキュメントを鵜呑みにせず、実際のコードと照らし合わせる」スキルが重要です。ドキュメントとコードに差異があれば、先輩に確認しましょう。

どのドキュメントから読めばいいの？

担当するタスクによって変わります。

最初は先輩に「この作業ではどのドキュメントを見ればいいですか？」と聞くのがベストです。