応用システムの文書化要領(JIS X 0126:2001; ISO/IEC 6592:1998)

現在ではもう廃止規格となってしまったが、それでもなお参考になることは多いので適当に抜粋しておく。使い方は規格を参照して欲しい。

番号構造 > 情報項目内容
1 システム要求
11問題の定義開発中のソフトウェアによって解決する問題の記述とその限界。
12目的ソフトウェアに期待する効果の記述とソフトウェアの要件。
13提案の根拠提案のねらいと根拠。
14参照文書開発の次のフェーズで参照する文書、例えば現在の状態を示す文書、の一覧。
15制約次のフェーズのために取得者が開発に際して定める要件(例えば、条件、制限、品質計画、安全保護)の記述。例えば、次のようなものがある。
- 人、材料、資金などの割り当てるべき資源
- 実装の方法
- 報告日付
- 完了日付
16言語文書に使用する言語を識別することが望ましい。例えば、日本語、フランス語、英語。
17契約情報契約情報を指定することが望ましい。版権の条件、ライセンス条項、使用条件及び保証事項を明記するとよい。第三者による保証のときには保証人を明示することが望ましい。
2 システム記述
21 システムの識別
211システム名称システムを識別するための名称及び可能ならば、品目番号又は製品コード。
212システムの目的システムの目的は、
- システムの直接効果
- 成果物を生産するときのシステム性能に対する要求、例えば、評価基準である。
22 詳細要求事項ソフトウェアの開発によって実現する物理的/論理的システムの記述。
221機能システムが支援するすべての論理的機能を含めた機能に対する要求事項であって、技術的な実現とは独立である。
222データシステムが必要とするすべてのデータを明記する。
223可用性可用性は、主としてシステムの利用可能性を示す数量(例えば、頻度、時間分布)である。
224制約制約は、安全保護、秘密、完全性、使用性などを含む。
225用語
226情報モデル
23 システム構成要素計画された又は既存のソフトウェアの要求事項を満たすシステムの構成要素の記述。
231 システム構成
2311構造
2312インタフェース
232 ソフトウェアの構成要素
2321ソフトウェア構成
2322データ構成
233 物理的な構成要素物理的な資源は、システム運用に必要な機器、用品及び設備である。
24 試験システムの目的や計画に基づき試験の要件、手順及び結果について記述する。
241試験目的
242試験方法とツール
243テストケース/ベンチマーク
25 導入新しいシステムを導入するために必要となる段階の記述。
251導入/使用方法
252教育訓練
26 人的資源
261要員
262組織
3 評価指標評価文書にはシステムを評価するために必す(須)なデータを含む。
4 結論/提言結論/提言は現実の結果に基づいた、意思決定者の見解であって、ソフトウェア開発を更に進める基礎となるものである。