コーディング規約とワークフロー評価キットを無料公開 ―RPAユーザーの高品質な開発を支援

開発規約と品質評価がなぜ必要なのか？

一般的にIT開発の現場では、開発における細かい基準（コーディング規約）を定め、規約に則した開発をおこない、また規約にもとづいて定期的に品質評価（コーディングレビュー）をおこなうというプロセスを設けることで、保守性・安全性などの品質を担保します。

他のIT開発と同様に、RPAのワークフロー開発においても、ワークフロー開発の規約を設けそれに沿った開発をおこなうことで、安定した、処理速度の高い、メンテナンスのしやすいワークフローを開発することが可能になります。チームで開発する大規模なプロジェクトの場合でも、一人や少数の限定されたデベロッパーが開発をおこなっている場合でも、開発の規約を設けていることで、安定して動作する・高速で処理できる等の品質面を保持したり、修正・変更を加えることが容易になったり、エラー発生時の原因特定が迅速におこなえたり、といったメリットがあります。

しかし、まだ新しいテクノロジーであるRPAの開発においては、これまで明確な開発の規約やルールの雛形が作られておらず、ワークフローの品質面の課題がありました。今回UiPathは、UiPath RPAの開発現場ですぐに、安心してお使いいただけるものとして、「UiPath コーディング規約 と ワークフロー品質評価キット」を公開いたしました。 

UiPathコーディング規約とワークフロー品質評価キットとは？

「UiPath コーディング規約とワークフロー品質評価キット」には、次の4点が含まれています。

1. UiPathコーディング規約

2. コードレビューチェックリスト

3. Workflow Inspector（WI）*こちらはUiPath Go! からダウンロードしていただけます

4. 品質評価キット用WI 設定ファイル

また、ダウンロードいただくと、zipファイルの中に本キットの取扱説明書が含まれています。 

UiPathコーディング規約

「UiPathコーディング規約」は、UiPathのRPA 開発で推奨するルールや知識をまとめた文書です。UiPathのお客様の導入事例・サポートから得たナレッジをもとに体系化されたもので、すでにUiPathをお使いのユーザーの方やこれからUiPathを使って開発を始められる方が、ダウンロードしてそのまま規約としてお使いいただくことも、すでに独自で作られている開発ルールを改良する際に参照いただくこともできます。すでに開発済みのUiPath RPAワークフローについても、修正や変更のタイミングで規約に則すかたちに改良することによって、保守性などの品質の向上・担保をすることが可能です。 

また、UiPathコーディング規約には、開発ルールとして現場でお使いいただけるものにプラスして、例外処理の構成方法や、セレクターの構成方法など、開発におけるTIPS も含まれており、UiPath RPAの学習の教材としてもご活用いただくことができます。

UiPath ワークフロー品質評価キット

コーディング規約以外の3点は、規約に則してワークフローの品質を定量・定性的に評価するためのツールです。

⚫ コードレビューチェックリスト は、ワークフローのコードレビューを規約に基づいて実施する際に、チェックするべき事項がまとまっているリストです。リストの各項目には「Must」「Should」という重要度のフラグがあり、重要度にわけて段階的にレビューをおこなうことも可能です。

⚫ Workflow Inspector は、UiPath Go! からダウンロードしていただくことができ、コードレビューチェックリスト内のチェック項目の一部を、自動的にレビューすることができるツールです。コードレビューチェックリスト内のどの項目をWorkflow Inspectorでレビューすることができるのかは、チェックリスト内の「確認方法」のフラグでご確認いただけます。

⚫ 品質評価キット用WI設定ファイル は、本キットに沿ったかたちでWorkflow Inspectorを設定するためのファイルです。

また、今回公開されたコーディング規約や品質評価キットは、UiPath Studioに標準で含まれている開発テンプレートRe-Frameworkと整合性が取れるかたちで作成されており、すでにRe-Frameworkをお使いいただいているお客様にも安心してご利用いただけます。

コーディング規約に則した開発で、品質の向上を

UiPathコーディング規約は、下記のようなワークフローの品質を保持するために作られています。

• 可読性 (読みやすく、処理の意図が把握しやすい)

• 保守性 (どこを修正すべきか分かりやすく、また修正による影響が予測しやすい)

• 安定性 (安定して動作する)

• 再利用性 (作成済み・テスト済みのワークフローをそのままの形で再利用しやすい)

• 信頼性 (エラーが発生しにくく、また発生した場合でも回復が容易である)

• 効率性 (少ないリソースで高速に動作する)

• 安全性 (機密情報を不正アクセスから守る)

• 一貫性 (命名規則や処理の構造などが複数のワークフローで統一されている)

たとえば、ログのレベルの付与の仕方を統一することで、エラー発生時にエラーが起こった処理のログだけを参照するといったことが可能になります。ログレベルを適切に設定していないと、莫大なログの中にエラーのログが埋もれてしまい、適切にエラーを処理することができなくなります。 

また、開発を始める前には、プロジェクトや変数の命名規則を定めておけば、開発チーム内のコミュニケーションもスムーズになり、メンテナンスも容易になります。命名規則は、コーディング規約に基づいて、企業ごとに独自のルールを設けてから開発を始める必要があります。 

RPAジャーニーを成功させるために

プロジェクトの規模に関わらず、RPAプロジェクトを成功させるためには、ガバナンスの要件や開発体制を満たすことに加え、開発の基準を設けてそれに則した開発をおこなうこと、また定期的にコードレビューを実施することが必要不可欠です。

「UiPath コーディング規約とワークフロー評価キット」は下記から、今すぐ無料でダウンロードいただけます。より保守性・安全性の高い高品質なワークフローを開発し、RPAジャーニーを成功に導きましょう。

→「UiPath コーディング規約とワークフロー評価キット」