Skip to main content

Rigorous Review of Design Documents by Review Points

Overview​

This sample demonstrates how to review Word-format design documents using a workflow that follows specified review points.

The workflow reads the target design document and the review points, then runs AI agents iteratively for each combination of review point and document chapter. The extracted review findings are output to an Excel file by an AI agent.

In this sample, the workflow sequentially performs document acquisition, review point retrieval, iterative review execution, and output to Excel. This lets you verify how tooling integration and AI agents can be combined to review Word documents by review point.

What this sample enables​

  • Read a review points list file and perform reviews using those points
  • Split a Word-format design document into chapters to organize review targets
  • Use AI agents to perform comprehensive reviews for each chapter × review point combination
  • Aggregate all extracted review findings and export them to an Excel file
  • Execute the end-to-end process step by step in a workflow, including file reading, chapter extraction, review execution, and result aggregation

Intended users​

This sample is mainly intended for people who:

  • Want to streamline and standardize design document reviews
  • Want to comprehensively check documents based on review points
  • Want to experience iterative execution using workflows

Included items​

This sample includes example data as listed below.

tip

You can run this sample as-is to verify the behavior, and then replace the input/output files with your own deliverables to test in a scenario closer to your real work. When replacing files, follow the steps described in "Procedure for replacing with your own deliverables" and perform the "Procedure" accordingly.

TypeContentProcedure for replacing with your own deliverables
Workflow definition章と観点ごとにWord設計書をレビューしてExcelに指摘を出力.yamlNot changeable
Agent definitionsWord設計書レビュー_指摘JSONを生成.yaml
レビュー結果Excel生成.yaml		Not changeable
Input: review points fileinputData/reviewPointList.json1. Place your review points file in JSON format in the inputData folder.
2. Specify the path in step 4 of the Procedure.
Input: Word design documentinputData/APPレイヤコンポーネント設計書.docx1. Place your design document in Word format in the inputData folder.
2. Specify the path in step 4 of the Procedure.
DocumentationThis READMENot changeable

Using the sample data​

Prerequisites​

  • The Word-format design document to be reviewed must be placed at the specified file path
  • The Excel file to which review findings are output must be open and active

Inputs / Outputs​

  • Inputs: review points list file, Word-format design document
  • Output: aggregated list of all review findings (Excel format)

Procedure​

  1. Open and make active the Excel file where findings will be output.
  2. In the DC Agentiqs workflow screen, click "章と観点ごとにWord設計書をレビューしてExcelに指摘を出力".
  3. On the "章と観点ごとにWord設計書をレビューしてExcelに指摘を出力" screen, click "Run".
  4. When the dialog appears, enter the "Review points list file path" and the "Word design document file path", then click "Run".
  5. After the workflow completes, the review findings will be output to Excel.

Components used at runtime​

  • Workflow: 章と観点ごとにWord設計書をレビューしてExcelに指摘を出力
  • Agents: Word設計書レビュー_指摘JSONを生成, レビュー結果Excel生成

Limitations​

  • Because this sample feeds chapters to the agent for review, if a single chapter is very large the accuracy may decrease. In such cases, customize the input range for the agent (for example, to section-level units).
  • The review points must be usable in the format expected by the workflow and agents. If the structure or content differs, workflow modifications may be required.

Reference: Workflow execution flow​

This sample uses a workflow to decompose processing into stages and execute the review process by combining tools and AI agents.

  1. Read the review points list file and structure it so that you can loop over each review point.
  2. Read the Word-format design document and structure it so that you can loop over chapters.
  3. For each chapter and each review point, submit inputs to the review agent in turn and extract review findings.
  4. Output the extracted review findings to Excel.
Last updated on