dejiren TOP/よくある質問

FAQ

よくある質問

メンテナンスしやすい手順書を作るポイント

手順書を作成する際に以下の点に気をつけると、後で修正しやすくなります。

  1. ブロック名をわかりやすい名前に変更する
  2. 同じことを複数の箇所で書かない
  3. 条件分岐の階層を浅くする
  4. 手順書を他の人に見てもらう

1. ブロック名をわかりやすい名前に変更する

ブロックを手順書に配置した直後はブロック名がそのまま表示されますが、名称を変更できます。具体的な処理がわかるようにブロック名を変更すると、手順書全体の見通しがつきやすくなります。

ブロック名を設定していない例
ブロック名を設定した例

ブロック名を設定すると、後ろのブロックで値を参照するときにも、設定したブロック名が表示されます。特に同じブロックが複数ある場合に区別しやすくなるので、手順書を作成または修正しやすくなります。

ブロック名を設定せずに値を参照する例
ブロック名を設定して値を参照する例

2. 同じことを複数の箇所で書かない

同じことをさまざまな箇所で書くと、修正したいときにすべての箇所を同様に修正することになります。1か所に集約すると、その1か所を変更するとすべての箇所に変更が反映されるので、修正漏れが発生しにくくなります。

以降で具体例を挙げます。

複数のブロックで使う文字列は共通化する

たとえば、特定の文字列が名前に含まれるファイルを、社内のファイルサーバーやboxなどさまざまな場所で検索するとします。

このとき、[ファイル検索]ブロックに直接検索キーワードを入力することもできますが、検索キーワードを変更するときにすべての[ファイル検索]ブロックを修正する必要があります。

検索キーワードを直接入力して指定する例

この場合は[テキスト作成]ブロックを使います。

  • [テキスト作成]ブロックで、検索キーワードを定義する
  • [ファイル検索]ブロックで、定義した検索キーワードを参照する

こうすることで、キーワードを変更したい場合に[テキスト作成]ブロックを変更するだけで済みます。

検索キーワードを[テキスト作成]ブロックで作成して指定する例

同じ処理をしている箇所は、1か所にまとめる

たとえば、受け取ったメッセージの内容によって異なる処理をし、処理後に「処理が完了しました」というメッセージをチャットに送るとします。

この場合は分岐ごとにメッセージを送るのではなく、分岐の後にまとめてメッセージを送ると、送信するメッセージの内容を変更したいときに1か所を変更するだけで済みます。

同じ処理が複数ある例
同じ処理をまとめた例

2つ以上の箇所で文字列が含まれるか判定するときは、[テキスト分析]ブロックに置き換える

たとえば、メールの件名に「至急」や「緊急」が含まれるときに特別な処理をするとします。[条件で分岐]ブロックを使うと「至急」や「緊急」を含むか判定できますが、手順書内の処理が増えていき、別の箇所でも同じ判定をしたくなったとします。このとき、もし同じ内容の[条件で分岐]ブロックを作成すると、判定する文字列を変更したい場合、すべてのブロックで条件を書き換える必要があります。

このような場合は、[テキスト分析]ブロックを使います。

  • [テキスト分析]ブロックで、メールの件名に指定した文字列が含まれるか判定する
  • [条件で分岐]ブロックで、[テキスト分析]ブロックで作成したルールに一致するかを判定する

こうすることで条件の主要な部分を1か所だけで定義でき、判定のための文字列を変更するときに[条件で分岐]ブロックを修正する必要がなくなります。

別の箇所で同じ文字列を判定する例
[テキスト分析]ブロックで文字列を判定する例

ただし、「至急」や「緊急」に加えて「火急」が含まれる場合も特別な処理をしたいなど条件を増やしたい場合は、[テキスト分析]ブロックだけではなく[条件で分岐]ブロックも修正する必要があります。

3. 条件分岐の階層を浅くする

複数の条件に該当する場合に特定の処理をしたい場合、可能な限り条件を1つにまとめた方が見やすくなります。

たとえば、「『稟議』フォルダーにあり、ファイル名に『発注』が含まれるファイルが更新されたとき」に何か処理をしたい場合、次のように条件を分けて書くこともできます。

条件分岐の階層が深い例

しかし、次のように条件をまとめることで分岐の階層が減り、わかりやすい手順書になります。

条件分岐の階層が浅い例

4. 手順書を他の人に見てもらう

手順書を作った後に、他の人にレビューしてもらうのも1つの方法です。
他の人が見て、何をしているか理解するのに時間がかかる手順書なら、修正する余地があるかもしれません。


キーワードから探す

キーワードから探す


カテゴリから探す

カテゴリから探す