KYOSO PRASのブログをご覧いただき、ありがとうございます。
RPAエンジニアのWです。

担当者が異動や退職することで、作成されたロボットの仕様がわからなくなり、
メンテナンスが困難になるケースがあります。

特に、他の人が作ったロボットは、どのような意図で作成されたかを理解するのが難しく、
自分自身で作成したロボットであっても、時間が経つとどのような仕組みで動いているか忘れてしまうことがよくあります。

こうした状況に対処するために、私がロボット作成時にロボットの可読性をあげるために
意識しているポイントが2点あります。
これにより、ロボットが誰にとっても理解しやすく、管理がしやすいものとなります。

私がよく使用しているBizRobo!では、各処理を「ステップ」、複数のステップをまとめたものを
「グループ」と呼んでいますが、他のRPAツールを使っている場合は「ノード」や「アクション」などに
読み替えていただくと良いでしょう。

1. ステップ名をわかりやすく変更する

ロボットを作成する際、各ステップにデフォルトの名前ではなく、
処理内容がすぐに理解できるような簡潔な名前に変更することが重要です。

ステップの名前から、どのような操作や処理が行われているのかを直感的に把握できると、
後から見たときに迷うことが少なくなります。

加えて、処理の詳細な説明をステップのコメント欄に記載しておくことで、さらに理解しやすくなります。

2. ステップのグループ化を行う

関連する処理や同じような処理をグループ化することで、画面に表示されるステップの数を減らし、
全体の見通しを良くすることができます。

ステップが散らばっていると全体像を把握しづらくなるため、グループ化することで
一つの処理のまとまりとして認識しやすくなります。
これにより、メンテナンスやトラブルシューティングの際も、必要な箇所をすぐに特定できるようになります。

ここで、ステップ名の変更、グループ化を行う前と後の比較になります。

・ステップ名の変更、グループ化を行う前

・ステップ名の変更、グループ化を行った後

後者の方が一目でロボットの内容を把握しやすくなると思いますので、
ぜひステップ名の変更とグループ化を実施していただければと思います。

これらの工夫を取り入れることで、他の人がメンテナンスを行う際にも、
ロボットの仕様がわかりやすく、スムーズに作業を進められるようになります。

結果として、長期的な運用や管理が効率的になり、無駄な時間や労力を削減できるでしょう。

BizRobo!だとロボットから仕様書(ロボットの流れ)が出力可能

また、BizRobo!のバージョン11.3以降では、MC（Management Console）を利用している場合に、
新たな機能として、MCにアップロードされたロボットから簡易的な仕様書（ドキュメント生成機能）を
ダウンロードできるようになりました。

この仕様書はロボットの設計や動作の概要を示すもので、
ロボットがどのように作成されているかを視覚的に確認するために便利です。

以下にその具体的なダウンロード手順を記載しています。

この機能を活用することで、ロボットの仕様を迅速に確認でき、
特にロボットのメンテナンスや他の担当者への引継ぎ作業の際に大いに役立ちます。

作成したロボットの構造や機能を簡単に把握できるため、時間が経って仕様を忘れてしまった場合でも、
このドキュメントを参考にして作業を進めることができます。

また、引継ぎ時にこの仕様書を共有すれば、次の担当者がスムーズにロボットの運用や管理を行えるようになるため、
作業効率が大幅に向上することが期待されます。

このように、ドキュメントの生成機能を積極的に活用することで、
ロボットの管理や保守がより容易になり、業務の円滑な引継ぎが可能となります。

＜ドキュメント生成機能使い方＞

MC（Management Console）にログインし、リポジトリから「ロボット」をクリックします。

ドキュメントを生成したいロボットが格納されているプロジェクトを選択します。

ロボット名の隣にある、縦に並んだ3つの点のアイコンをクリックします。

「ドキュメント生成」をクリックします。

ドキュメントが生成されると、グループごとに整理されて表示されます。
ステップ名は「名前」の欄に、ステップのコメントに記載した内容は「コメント」の欄に表示されます。

「プリント」をクリックすることで、任意の場所にPDFファイルとして保存できます。

ドキュメント生成機能でロボットの途中までしか生成できない場合、不具合が発生することがあります。
もしドキュメントが途中までしか生成できない場合は、以下のURLをご参照ください。

・ドキュメント機能の不具合(BizRobo!ナレッジベースより)
https://knowledge.bizrobo.com/hc/ja/articles/22589858455961

---

この記事をお読みいただき、ありがとうございました。

ロボットの可読性向上やドキュメント生成の便利な機能を活用することで、業務がさらに効率的になることを願っています。