RPAの設計書のフォーマットを数々見てきましたが、各社ともバラバラです。
「こんな内容で本当にロボット作れるの？」といった粒度のものも多く、作り手の開発経験が顕著に表れます。
とはいえ、「じゃあどの程度の情報を設計書に盛り込めば良いの？」という疑問に答えるために、僕が現場で使ってきた設計書フォーマットをGitHubにアップしました。ぜひ参考にしてやってください。
https://github.com/falcslab/blueprism/tree/doc
- RPA_詳細設計書_サンプル.xlsx
使い方
最初に申し上げておくと、このフォーマットはBlue Prismでの開発用に作られたものです。他のRPAツールを使っている方は、そのツールに合うようにカスタマイズしてやってください。
全体概要
ここでは、ロボットが処理を行う上で閲覧するファイル、フォルダや、操作するシステムなど、ロボットを取り巻く環境の全体図を書くシートです。
サンプルの絵は大変雑なので、あまり参考にしないようにお願いします
処理フロー
メインとなるシートです。
各項目の説明は以下のとおりです。
| 処理大分類～小分類 | ロボットが行う処理を最大3分類にカテゴライズできるようにしています。適宜設計書が見やすいように、処理を区分けしてください。 |
| ループ、分岐範囲 | 処理小分類の右にある、3列です。 ここではループ範囲や条件分岐部分を色で明示するのに使います。 |
| 処理内容 | 具体的なロジックを書いていきます。 – ファイル移動であれば、どこからどこに移動させるのか具体的に書く – キューデータ登録であれば、どの項目にどんなパラメータを登録するのか書く といった具合に、なるべく具体的に書きます。 |
| 例外処理 | 「処理内容」部分で発生しうる例外パターンを列挙します。 処理内容より例外処理に記載する内容の方がボリュームが多くなったりしますが、気にせず列挙していきます。 |
| 備考 | 設計中に「あれ？ここってどういうロジックにするべきか、業務担当者に相談しなきゃ…」といった具合に、一度設計を保留にしなければならない箇所が必ず出てきます。 そのときにこの備考欄にメモを残しておき、解決したら「処理内容」「例外処理」に書き込んでいきます。 |
| テストケース | 「処理内容」「例外処理」をテストするためのテストケースを記載します。 例えば、例外処理が複数パターン存在する場合、そのすべてに対して、どういったテストデータをもとにテストをするのか？など、条件やテスト方法を明記していきます。 |
| 作成日～結果、テスト結果備考 | テスト実施日、確認日、確認結果 NGの場合、どこがNGだったのかを記入します。 |
ちなみに、方眼紙仕様？で設計書を作っている理由は、
処理内容や例外処理の記載ボリュームが膨らみすぎて、1セルに記載できる文字数を超過することが多々あったからです。
また、処理内容を字下げして記入していくときに、方眼紙仕様だと記入しやすかったり、設計書の修正もしやすいので、この形式にしています。
欠点はキーボードだとセル移動がもたつくことですかね。。。
その他のシート
ワークキュー、環境変数、セッション変数、環境ロックについては、今回開発するプロセスに関連するものを列挙して、詳細を記載していきます。
その他注意点
インプットデータにより処理フローが分岐する場合、1シートでは表現しにくいと思います。
例えば、インプットデータAではA画面を経て処理終了するが、データBではA⇒B画面を経て処理終了する、といった場合、
処理フローをシートごと分けて記載したほうが分かりやすいです。
業務仕様に応じて、適宜シートを小分けして記入するようにしてください。
まとめ
他ドキュメントと同様、随時改良予定です。
使うときは自己責任でお願いします。
が、実務で使ったこともあるフォーマットなので、全然使えないものというわけではないとは思います。
ぜひ参考にしてやってください。
