OutSystems用ドキュメント自動生成ツールを触ってみた

ForgeにあるOutSystems向けドキュメント自動生成ツールOutDocの動作を試してみました。

公式情報

OutDoc(Forge)

.NETスタックのみ。残念ながら詳細なヘルプページなどはない様子。

APIが用意されているし、上のリンクからダウンロードできるOutDoc自体がOutSystemsで作成されたモジュールなので、プロジェクトや企業としてのドキュメント整備方針に合わせてカスタマイズできますが、まずは標準で確認してみます。

2016/7時点の最新バージョン2.3.0で確認します。

開発環境にインストールしたOutDocモジュールを開いて、Open in Browserボタンでブラウザで開きます。

開発したアプリケーションなどはeSpacesタブにあります。

eSpacesに並んだアプリケーションから「WorkAssignment」というアプリケーション名をクリックしたところ。

アプリケーションの内部を見てドキュメントを作ってくれます。

出来上がったドキュメント。

まずは目次。

ドキュメント一部(目次でいうと3.1と3.2の一部)

「どんな要素があるか」を一覧するとこまでですね。

EntityなんかはAttributeの名前や型、必須指定なんかが自動的に出てきていい感じです。

逆にWeb ScreenやAction内部の設計情報(フローや配置したオブジェクトの情報など)は出てきません。

ScreenにどんなActionがあるかは一覧で出ますが、なぜかPreparationがでていなかったり。

また、アプリケーションのバージョン指定をするところがなかったので、最新バージョンのドキュメントしか取れないみたいです。

ユーザとの仕様調整に使えるようなドキュメントは出てこないので、要件定義書や基本設計書相当として使うのは無理そう。

Web ScreenやActionの詳細やコメントがでないから、保守担当者が処理の概要つかんだりテスト設計書の材料にもならないかな。

今このままだと、どんな構成要素があるかを一覧するためのリファレンス、納品ドキュメントが必要なとき、その一部として利用ぐらい？

Doc APIというタブがあって、ドキュメント出力用の部品定義があるので、必要なカスタマイズを施せば実装に近いレベルの設計書は自動で出せるようになるかも。OutDoc自体のドキュメントがないので試行錯誤で対応することになりますが……。