Rational Review of Design Documents by Review Criteria

Overview

This is a sample of reviewing a Word design document using a workflow, following specific review criteria.

The design document to be reviewed and the review criteria are read, and the AI ​​agent is repeatedly executed in units of review criteria × chapter.
The extracted review findings are output to Excel by the AI ​​agent.

In this sample, the process from acquiring the document to be reviewed, acquiring the review criteria, repeatedly executing the review, and outputting to Excel is executed sequentially as a workflow.
This allows you to see how to proceed with reviewing a Word document by review criteria while combining tool integration and an AI agent.

What this sample can do

• Read a review perspective list file and perform a review using the review perspectives.
• Break down a Word-format design document into chapters and organize the review targets.
• Utilize an AI agent to perform a comprehensive review using combinations of chapters and review perspectives.
• List all extracted review findings and output them in Excel format.
• Use a workflow to execute a series of processes, from file reading and chapter extraction to review execution and result aggregation, in a step-by-step manner.

Target Users

This sample is primarily intended for the following users:

• Want to streamline and standardize design document reviews.
• Want to comprehensively review documents based on review perspectives.
• Want to experience iterative execution using a workflow.

Package Contents

This sample includes the following data as an example:

Type	Content
Workflow Definition	Review Word design document chapter by chapter and perspective and output findings to Excel.yaml
Agent Definition	Generate Word design document review findings JSON.yaml Generate review results Excel.yaml
Input: Review perspective file	reviewPointList.json
Input: Word design document	APP layer component design document.docx
Documentation	This README

Using Sample Data

Prerequisites

• The Word design document to be reviewed is located in the specified file path.
  
• The Excel file to output review findings is open and active.

Input/Output

• Input: Review perspective list file, Word design document
  
• Output: List of all review findings file (Excel format)
  

Procedure

1. Open and activate the Excel file to output the findings.
2. On the Agentiqs workflow screen, click "Review Word design document by chapter and perspective and output findings to Excel."
3. On the "Review Word design document by chapter and perspective and output findings to Excel" screen, click "Execute."
4. A dialog box will appear. Enter the "Review Perspective List File Path" and "Word Design Document File Path," then click "Execute."
5. After the workflow is complete, the review findings will be output to Excel.

Target Operation

• Workflow: Review Word design document by chapter and perspective and output findings to Excel
• Agent: Generate Word design document review_findings JSON, generate review results Excel

Constraints

• This sample reviews by inputting data into the agent on a chapter-by-chapter basis. Therefore, if a chapter is very large, the accuracy may decrease.
  In that case, customize the range of input to the agent, such as by section.
• Review perspectives must be available in the format expected by the workflow and agent.
  If the structure or content differs, the workflow will need to be modified.

Reference: Workflow Execution Flow

This sample demonstrates how to break down the process step by step using a workflow, and how to execute a series of review processes by combining tools and an AI agent.

1. Read the review perspective list file and format it into a loopable structure for each perspective.
2. Read the design document in Word format and format it into a loopable structure for each chapter.
3. Input each chapter and each review perspective into the review agent in order and extract review findings.
4. Output the review findings to Excel.