SuperAPI AI Directory

req-merger

General & other

View repository

Updated 10-15 17:26

About this skill

Requirement Merge Skill

Goal

Integrate cleaned-requirements/issues.md the question answers into the requirements document to generate complete requirements.

Input/Output

  • Input:cleaned-requirements/index.md、cleaned-requirements/issues.md(answers filled in)
  • Output:clarified-requirements/index.md

Core Principles

  1. Faithful integration: Accurately reflect the question answers, do not improvise
  2. Appropriately maintain structure: Maintain the structure and format of the original requirements document, adjust when necessary to improve clarity
  3. Clearly annotate: New content must be clearly identifiable

Execution Flow

1. Integration methods

Common integration methods (flexible choice):

Method 1: Directly update the original text

  • Applicable scenario: The answer is a supplement or correction to the original text
  • Example: Original text "Users can upload images" → Updated to "Users can upload images (supports jpg/png/gif, max 5MB)"

Method 2: Add a supplementary explanation section

  • Applicable scenario: The answer is a newly added rule or explanation
  • Location: Add "## Supplementary Explanation (based on question clarification)" at the end of the document

Method 3: Merge into the original text

  • Applicable scenario: The answer needs to be deeply integrated with the original text
  • Requirement: Ensure logical coherence, no abruptness

Core requirement: Regardless of which method is used, it must be ensured that the answers are completely integrated with no omissions.

2. Operation steps

  1. Copy cleaned-requirements/index.md to clarified-requirements/index.md
  2. Copy cleaned-requirements/assets/ to clarified-requirements/assets/(if there are images)
  3. Read cleaned-requirements/issues.md all questions and answers in
  4. Process each question one by one:
    • Find the original text location corresponding to the question
    • Determine whether to use Method 1 or Method 2
    • Integrate the answer into the document
  5. Generate clarified-requirements/index.md

3. Answer check

Answer completeness check:

  • Confirm that all critical priority questions have been answered
  • Confirm that all warning priority questions have been answered or marked as "to be supplemented"
  • If critical questions are unanswered or answers are incomplete, the user must be prompted to supplement
  • If warning questions are unanswered, suggest the user supplement (not mandatory)

Supplement strategy:

  • Questions related to the core flow: must supplement
  • Questions related to boundary conditions: suggest supplement
  • Questions related to exception handling: suggest supplement
  • If the user has finished filling in and asks you to continue, but you feel the logic is still unclear, you may ask the user again

Examples

Example 1: Directly update the original text

Original text:

用户可以上传图片

Question answer:

支持格式:jpg, png, gif
大小上限:5MB

After update:

用户可以上传图片(支持 jpg/png/gif,最大 5MB)

Example 2: Add supplementary explanation

Original text:

系统应快速响应

Question answer:

接口响应:<200ms
页面加载:<2s

After update (added at the end of the document):

## 补充说明(基于问题澄清)

### 性能指标
- 接口响应:<200ms
- 页面加载:<2s

Checklist

  • All critical questions have been answered
  • All warning questions have been answered or marked as "to be supplemented"
  • Answers have been integrated into the document
  • New content is clearly identifiable
  • The original document structure has been maintained
  • Image resources have been copied to clarified-requirements/assets/
  • clarified-requirements/index.md generated