エンジニアのドキュメンテーションについてのメモ
なぜドキュメントを整備する必要があるのか
システムや機器を作成する際にドキュメントを整備していないと、自分がそれらを使う分には問題ないが、他の人はそれの使い方が分からない状態になる。
すると、他の人はそれを使って仕事できなくなる上、他の人が仕事できない分、自分の仕事が増えてしまう。
それを防ぐため、システムや機器を作成する際には、誰にでも使えるようにドキュメントを整備する必要がある。
どのようなドキュメントが使われているのか
使われるドキュメントとして、主に以下のものがある。
- 要件定義書
クライアントの要求について、何をどのようにするのかを明確にして整理した文書。
クライアントと開発者がシステムの全体像を共有するために必要。
- 基本設計書
抽象的な要件を、より具体的にまとめた文書。
実際のシステム上ではどのように動作させるのかなどを書く。
クライアントと開発者が具体的な要件を共有するのに必要となる。
- 詳細設計書
基本設計で設計したシステムに、フローや入出力などを書き加え、システム全体の流れをまとめた書類。
開発者がプログラムを書く際の設計図として必要。
- マニュアル
ユーザー向けに、システムの操作の仕方をまとめた文書。