AlteryxのTipsを不定期にお届けしている週間（？）AlteryxTipsです。
Alteryxのワークフローは、直接コメントを書いたりブロック化できるため、そのままドキュメントになりえます。一方で、適切なバージョン管理をしなければ、当時のドキュメントというものが残らない可能性もあったりします。また、ライセンスを持っていないと中身を見ることができない、というのも大きな問題になる可能性を秘めています。
今回は、Alteryxのワークフローを外部ドキュメント化する方法について考えてみたいと思います。
既存のドキュメント化ツールについて
実は外部のドキュメント化は今までも様々な方がチャレンジされていました。いくつか代表的なものを紹介します。
WAM（Workflow Admin Manager）
Capitalizeという海外の会社は、WAMというツールを有償で提供しています。ドキュメント化だけではなく、様々な機能を持っているようです。紹介ビデオを見る限り、大量のワークフローを管理するようなツールになっているようで、サーバーとも連携できるように見えます。
監査レポートでは、ワークフローの全体感、各ツール間でどのようなデータが渡されているか（項目名、データ型など）をレポートとして表示でき、ワークフローのバージョンアップにより何が変化したか（設定、追加されたツール等）なども追えるようになっています。
参考URL：
Auto Documenter
keyrusという海外の会社は、Auto Documenterを開発しています。こちらは無償で提供されており、Gitで入手が可能です。ワークフローの全体、各ブロックごとの拡大図、ツール利用統計、入出力サマリー、各ツールの設定などがレポート化されます。サンプルレポートも提供されているので、実際どのような出力が得られるのか気になる場合は入手してみてください。
参考URL：
- Auto Documentation | Alteryx Community
- GitLab 配布サイト
ワークフローサマリーツール
Alteryxのベータプロダクトとして開発されたツールで、OpenAIのアカウントが必要です（実行にはOpenAIのAPIキーが必要です）。
内容としては、自然言語によるワークフローの要約になります（出力言語は英語）。
実行結果はこちらで確認できます。
参考URL：
- Introducing the Workflow Summary Tool, Powered by Generative AI | Alteryx Community
- How To Use the Workflow Summary Tool | Alteryx Community
Workflow Documentation
2026/03/23追加
ワークフローのドキュメンテーションツールを作成しました。使用する際は、GenAIツール、もしくはGoogle Geminiが利用可能です。つまり、LLMを使ってワークフローのドキュメント化を行っています。
本ツールは、LLMとワークフローXMLのパースの二段構えとなっていて、ワークフローのXMLから取れる情報はそちらをなるべく使うようにしており、LLMのコストをなるべく使わない方向としています。
2026年3月時点ではどうするか
既存のドキュメント化ツールでは各ツールの設定が提供されるだけで、そのワークフローが何をしようとしているかという部分は人間が読み取る必要がありました。
しかし、AIが非常に進化してきた現在においては、LLMがワークフローを解釈してくれるようになったので、これをうまく活用していくのが良いと思います。ベータプロダクトのワークフローサマリーツールはまさにこれを活用したツールですが、OpenAIのAPIキーが必要なのがネックです（意外と高くて、個人的に契約するのはためらわれます）。
しかし、2026年3月時点でいえば、Alteryx Copilotに聞けばオッケーというレベルになっています。ちょっとAlteryx Copilotについて見ていきましょう。
Alteryx Copilot
Alteryx Oneの契約があれば、Alteryx Copilotを使うことができます。要約を行いたいワークフローをまず開きます。
今回のワークフローは少し大きめのワークフローで、GoogleのGeminiを呼び出すためのワークフローです（まだ未公開です、、、そのうち公開したいのですが、Gemini側がバージョンアップしてしまったので・・・）。
Copilotを開くと、右上に「Summarize Workflow」とあるので、クリックしてみましょう。
すると、以下のように要約が始まります。
結果としては以下のように英語で出力されます。
内容としては、
- ツール数
- ワークフローの概要
- データソース
- 鍵となるロジック
- 出力データ
- テーマ
となります。上のサンプルは英語で出てきているので、「日本語に翻訳して」というと、ちゃんと日本語にしてくれます。
完璧ですね・・・。惜しむべき点は、これをそのままファイルとして出力してくれない点くらいでしょうか（コピペしてファイルに貼り付けて保存するしかできないですね）。
続きも貼っておきます。
Geminiで似たようなプロンプトを作ってもここまできれいに作ってくれないので、プロンプトはかなり工夫して作る必要があるように思います。そのため、現状Alteryx Copilotで要約を作成し、手動で内容を保存するのが最も良い選択肢ではないかと思います。ただ、大量のワークフローに対してこれを実行しないといけない、ということになるとこれはちょっと面倒ですね・・・。
ちなみに、各ツールの設定についてもCopilotに聞くと教えてくれます。
外部ドキュメントとして考えるために
現状、Alteryxのワークフローのドキュメント化は、Alteryx Copilotが最も精度よく簡単に実現可能です。しかしながら、固定的なドキュメントを大量に使いたい、といった場合には利用が難しいです。あくまで、開いているワークフローがどのようなものか、ワークフローの利用者の理解を助けるための補助ツールとして利用するのが最も良いのではないかと思います。
GeminiなどのLLMにざっくりワークフローを要約して、といったような聞き方ももちろん可能ですが、精度的にはAlteryx Copilotに劣ります。それなりのドキュメントにしたければ、指示プロンプトをかなり工夫する必要があるように思います。
大量のワークフローを一括でドキュメント化したい、といった場合、AlteryxのGenAIツールを適切なプロンプトで欲しい情報を取得し、ワークフロー化するのが最も良いように思います。
また、既存のツールで行っているようなツールの抽出などは「Workflow XML Parser」ツールなどもあるので、そちらを使った方がLLMのトークンの節約になるので、既存のやり方とLLMを活用したハイブリッドな方式が良いのではないかと思います。
まとめ
- Alteryxワークフローの外部ドキュメンテーションの自動生成について解説しました
- 既存のツール３つについてご紹介しました
- 現在は、Alteryx Copilotによるドキュメント化の精度が良いのですが、個別に行う必要があることが懸念点です。
- 既存のツールで行っているようなことと、LLMを使うハイブリッド的なやり方が良いのではないかと思います。
- 2026/3/28 LLMとXMLパースのハイブリッド方式によるツール「Alteryx Workflow Documentation with LLM」を作成したので、お試し頂ければと思います。
次回
未定です。
コメント