【ドキュメント】帳票一覧の記述内容と記述例（サンプル）

この記事では、「 IPA の機能要件の合意形成ガイド(ver.1.0)」に基づいて、帳票一覧の作成方法について簡易的に解説します。

IT プロジェクトにおいてはドキュメント作成が必要不可欠です。

アジャイル型開発の場合であっても、最低限のドキュメントは最終的に作成する必要があります。

帳票一覧とは

「帳票一覧」とは、当該システムが作成する帳票を一覧形式にまとめたものである。（出典：IPA 機能要件の合意形成ガイド(ver.1.0)）

そもそも帳票とは、会社や組織で使用される公式な書類の一種で、データや情報を整理して報告、記録、分析するために用いられます。

具体的には、請求書、受領書、報告書、予算表、給与明細書などさまざまな文書があります。

これらをシステムで作成する場合に、一覧形式でまとめたドキュメントが帳票一覧です。

同様に、IPA 機能要件の合意形成ガイド(ver.1.0) に基づくと、以下の内容がドキュメント上で管理されるべきとしています。

以下の項目は帳票一覧に限らず、各ドキュメントで共通で記載する内容です。（IPA 機能要件の合意形成ガイド(ver.1.0) に基づく）

以下の項目が帳票一覧で管理されるべき一般的な項目群です。（IPA 機能要件の合意形成ガイド(ver.1.0) に基づく）

項目内容	項目内容の説明
標準ID / 名称	標準を特定する識別子または名称を記述する。
出力タイミング	当該標準の出力タイミングを記述する。
出力対象	当該標準の出力対象（汎用性、専用性、PDFなど）を記述する。
項目サイズ	当該標準の項目サイズ上限値または記述する。

最低限この情報があれば、どのような帳票かを判断できるでしょう。

以下の項目が帳票一覧で管理されるべき任意項目群です。（IPA 機能要件の合意形成ガイド(ver.1.0) に基づく）

プロジェクトの内容やお客様の要望、システムや帳票の特徴に応じて記述内容は柔軟に変更・追加しましょう。

項目内容	項目内容の説明
中規範利用業務	当該標準を利用する主な業務名をを記述する。
中規範サンプル機構	当該標準を出力する主なシステム機構名をを記述する。
中規範形式の識別	当該標準の形式（一覧表、詳細表、集計表など）の識別を記述する。
中規範データの作成方法	当該標準の作成方法（手動、オンデマンド）を記述する。
改ページ条件	当該標準の改ページ条件を記述する。
出力制約条件	当該標準の出力制約条件を記述する。

帳票一覧のサンプルデータを、標準項目と任意項目を含む形で作成してみます。項目はプロジェクトに応じて適宜変えてください。

標準ID / 名称	出力タイミング	出力対象	項目サイズ	中規範利用業務	中規範サンプル機構	中規範形式の識別	中規範データの作成方法	改ページ条件	出力制約条件
INV-001 / 請求書	月末	全顧客	A4	財務管理	請求処理システム	一覧表	自動生成	顧客ごと	プリンタ設定必須
RPT-002 / 売上報告書	売上確定後すぐ	営業部門	A4	営業管理	売上管理システム	詳細表	手動入力	部門ごと	高解像度印刷
SAL-003 / 給与明細	毎月20日	従業員	A5	人事部門	給与計算システム	集計表	自動生成	1ページに10名	機密保持
BGT-004 / 予算計画表	年度初め	経営層	A3	経理部門	予算管理システム	集計表	手動入力	各部門ごと	なし
ORD-005 / 注文書	注文受付時	営業部門、顧客	A4	営業管理	注文管理システム	一覧表	自動生成	商品ごと	なし

ドキュメントは属人的になってしまうことが多いので、組織としてテンプレートを用意して同じような品質になるようにしたいですね。