成果物/追加開発ドキュメント のバックアップ(No.1)
- バックアップ一覧
- 差分 を表示
- 現在との差分 を表示
- ソース を表示
- 成果物/追加開発ドキュメント へ行く。
- 1 (2014-06-26 (木) 11:04:26)
アドオンに係る、ドキュメントについて。
概要 †
分類 †
一般的には、下記にグルーピングすることができる。
- 基本設計書・概要設計書・外部設計書etcと呼ばれる、コンセプトやプラットフォームならびに技術的制約が記されているドキュメント
- 詳細設計書・内部設計書etcと呼ばれる、上記１に数式やマッピングおよび書式等の細微なレベルが補足されているドキュメント
- 上記について、一覧などで網羅性を担保するドキュメント
これらについては、各々のベンダで定義されており、同じ言葉を使用していても意味が異なることが起こり得るため、当wikiでは下記の通りに定義する。
A †
業務の遂行に必要な手順と手段が網羅されており、マニュアル作業かシステム化の対象であるか、またシステム化の対象であっても、SAP標準であるかアドオン対象であるかを定義したドキュメント。 業務プロセス一覧、業務プロセスフロー、要件定義書など。つまり、業務設計ドキュメントの範疇とする。
B †
上記Aのうち、Add-on化の検討対象となり、採用可否の判定とその理由や経緯が記録されたドキュメント。 追加開発一覧、課題管理表、変更管理表などが該当するが、論点がブレるため追加開発一覧のみ追加開発ドキュメントの範疇とする。
C †
上記Bのうち、採用となったAdd-onテーマについて、要求される機能と実装手段の概要、および制約条件が漏れなく記述されたドキュメントを指し、概要設計書と呼ぶ。
D †
上記Cについて、機能要求が実装可能なレベルで記述されたドキュメントを指し、詳細設計書と呼ぶ。
E †
上記BおよびCで定義した機能について、記述通り動作することおよび記述外の動作をしないことについて、試験日・試験項目・試験結果を記述したドキュメントを指し、実装者が作成するものを単体テスト結果記述書と呼び、実装者<>設計者の場合に設計者が作成するものを受入テスト結果記述書と呼ぶ。
F †
システムに実装したリポジトリオブジェクトについて、オブジェクト名やテーブルや汎用モジュールなどの分類の記載、および実装の理由や要因（アドオン、モディフィケーション、Noteなど）が補足されているドキュメントを指し、オブジェクト一覧と呼ぶ。
なお、このページでは、設計フェーズ〜実現化フェーズにおいて作成するB〜Fそれぞれについて、下記に詳細を記す。
前提 †
ログとして残すことが重要かのように語られることが多く、確かにその面も勿論なのだが、それだと後付け的に「何であれ、残せばいいんでしょ」となってしまいがち。
最も重要なのは、形になる前に形にすること。 時間的な、要員的な制約から「それはできない」と言われがちだが、一定程度の品質を保つためにはこうするほかないのだ。
さもなくば、カプセル化や参照整合性の保持が無駄なく成立しなかったり、更に具体的には変数の重複・iTABの設計と利用・ネーミングルールのグダグダ化など、ロクなことにならない。
しかし、ずっと自分が面倒みる訳ではないからと書き逃げする輩にとっては上記の観点は鬱陶しいだけに過ぎず、放っておいたら際限なく適当にやりだす。
先達やリードとして、こういった残念な人も戦力として組み込まなければならない場合、啓蒙・誘導のほか、「レビュー」という重要な工程を時間と気力を割いてでも実施しなければならないという覚悟を欠いてはならない。
規約 †
上記の括りには含まれないが、重要なドキュメントとしてコーディング規約とオブジェクト命名規約があり、それぞれリンク先を参照されたい。
コメントはありません。 Comments/成果物/追加開発ドキュメント