設計書を観点別に厳密にレビュー
概要
Wordの設計文書を対象に、ワークフローを用いてレビュー観点に沿ったレビューを行うサンプルです。
レビュー対象の設計文書とレビュー観点を読み込み、レビュー観点 × 章の単位で繰り返しAIエージェントを実行します。
抽出したレビュー指摘はAIエージェントによりExcelに出力します。
本サンプルでは、レビュー対象の取得、レビュー観点の取得、レビューの繰り返し実行、Excelへの出力までをワークフローとして順に実行します。
これにより、ツール連携とAIエージェントを組み合わせながら、Word文書に対してレビュー観点ごとにレビューを進める流れを確認できます。
このサンプルでできること
- レビュー観点一覧ファイルを読み込み、レビュー観点を利用したレビューを行う
- Word形式の設計書を章単位で分解してレビュー対象を整理する
- 章 × レビュー観点の組み合わせでAIエージェントを活用して網羅的にレビューを実行する
- 抽出した全レビュー指摘を一覧化し、Excel形式で出力する
- ワークフローにより、ファイル読込、章抽出、レビュー実行、結果集約までの一連の処理を段階的に実行する
想定ユーザ
このサンプルは、主に以下のような方を想定しています。
- 設計書レビューを効率化・標準化したい
- レビュー観点に基づいて文書を網羅的に確認したい
- ワークフローを用いた繰り返し実行を体験したい
同梱内容
このサンプルには、例として以下のようなデータが含まれています。
| 種別 | 内容 |
|---|---|
| ワークフロー定義 | 章と観点ごとにWord設計書をレビューしてExcelに指摘を出力.yaml |
| エージェント定義 | Word設計書レビュー_指摘JSONを生成.yaml レビュー結果Excel生成.yaml |
| 入力：レビュー観点ファイル | reviewPointList.json |
| 入力：Word設計書 | APPレイヤコンポーネント設計書.docx |
| ドキュメント | 本README |
サンプルデータの利用
前提条件
- レビュー対象となるWord形式の設計書が所定のファイルパスに配置されていること
- レビュー指摘を出力するExcelファイルが開かれ、アクティブにであること
入出力
- 入力：レビュー観点一覧ファイル、Word形式の設計書
- 出力：全レビュー指摘の一覧ファイル（Excel形式）
作業手順
- 指摘を出力する先のExcelファイルを開き、アクティブにします。
- DC Agentiqsのワークフロー画面で「章と観点ごとにWord設計書をレビューしてExcelに指摘を出力」をクリックします。
- 「章と観点ごとにWord設計書をレビューしてExcelに指摘を出力」の画面で、「実行」をクリックします。
- ダイアログが表示されるため、「レビュー観点一覧ファイルパス」と「Word設計書ファイルパス」を入力し、「実行」をクリックします。
- ワークフローの完了後、Excelにレビュー指摘が出力されます。
動作対象
- ワークフロー：章と観点ごとにWord設計書をレビューしてExcelに指摘を出力
- エージェント：Word設計書レビュー_指摘JSONを生成、レビュー結果Excel生成
制約事項
- 本サンプルは章単位でエージェントに入力してレビューするため、1つの章のボリュームが大きいと精度が下がる可能性があります。
その場合、節の単位などエージェントに入力する範囲をカスタマイズしてください。 - レビュー観点はワークフローおよびエージェントが想定する形式で利用できる必要があります。
構造や内容が異なる場合は、ワークフローの変更が必要になります。
参考：ワークフロー実行の流れ
本サンプルでは、ワークフローを用いて処理を段階的に分解し、
ツールとAIエージェントを組み合わせて一連のレビュー処理を実行する構成を確認できます。
- レビュー観点一覧ファイルを読み込み、観点ごとにループできる構造に成形する。
- Word形式の設計書を読み込み、章単位でループできる構造に成形する。
- 各章、各レビュー観点の単位で順番にレビューエージェントへ入力し、レビュー指摘を抽出する
- レビュー指摘をExcelに出力する。