侠Liangshen AIailiangshen.com
AI Implementation Course · Short topic lessons · Lesson 11

Technical Documentation and Requirements Review

Quickly obtain meeting minutes and a change list after the review, and ensure interface descriptions keep pace with implementation.

Freeabout 10 minNo experience neededWeb lesson + slides + video

The goal is to quickly obtain meeting minutes and a change list after the review, and ensure that interface descriptions keep pace with implementation. This lesson follows the rule from P06: mark what is missing, do not guess.

By the end of this lesson, you can

  • A requirements change list: what changed, what needs confirmation, responsible person, and deadline
  • An interface description rule: fields can only come from the field table
  • A conflict list between two versions of requirements
  • Each change must correspond to the original words in the review

These three items are materials for the 'Process' and 'Human-Machine Division of Labor' columns of the project card

01

Opening

About 1 minutes

Let's Look at a ScenarioFictional example, numbers are illustrative

Product Manager He Wenqing · Qilan Intelligence

He Wenqing attends three to four requirements review meetings per week, each lasting about 75 minutes.

After the meeting, she needs to organize minutes and compare them with the previous version of the requirements text to list what changed and who needs to follow up.

There are many versions of the requirements text, making it often unclear what was changed, and the minutes are not issued until the next day.

Dragon Warrior is good at organizing text. However, it is most likely to casually add requirements, writing logically about things not discussed in the meeting.
02

Methods and Templates

About 5 minutes

Process: De-identify, compare two versions, humans verify item by item

De-sensitizationReplace feature names with codenames; do not disclose unpublished details, roadmaps, or client names.
→
Post both versions with records.Post the text of the old and new requirements along with review records. The output must include four columns: Changes, Items Pending Confirmation, Responsible Person, and Deadline.
→
Write the rules.Do not fill in missing items, do not treat discussions as decisions, and do not add features not present in the requirements.
→
Identify conflicts.List the conflicts between the two versions and note at least two possible interpretations of each ambiguous statement.
→
Human verification.Verify each item one by one: Was this change actually discussed in the meeting? Items pending confirmation must not be filled in by the AI.
For versions sent to clients or external parties, the Product Manager must approve them.
Tip

Prompt 1: Change List

Suggested time
Prompt 1: Change List
Below are the old requirements, new requirements, and meeting review notes for Feature Alpha (codename).
Please output:
1. Change List (table) with columns: Change Point, Old Version Text, New Version Text, Corresponding Quote from Review Notes
2. Items Pending Confirmation: List missing responsible persons, missing deadlines, and unresolved issues from the review as individual questions
3. Conflicts or inconsistencies between the two versions
4. Ambiguous Statements: List sentences that have at least two interpretations
Rules:
1. For responsible persons and deadlines not explicitly stated in the records, mark as 'Pending Confirmation'. Do not guess.
2. Do not add features not in the requirements or statements not made in the meeting.
3. Phrases like 'Let's review again' or 'Write it this way for now' are not decisions and should not be included in the Change List.
Use only the provided content. Mark missing information as 'To be supplemented'. Do not fabricate.
Old Version: [Paste]
New Version: [Paste]
Review Notes: [Paste]
Each change must correspond to a quote from the review notes. Items that were only discussed without a final decision should be placed in 'Items Pending Confirmation'.

Example: Which changes have supporting quotes, and which do not?Fictional example, numbers are illustrative

What is written in the new version?

Export range changed from 30 days to 90 days (illustrative); send in-app notification upon completion; export content includes username.

Are there supporting quotes in the review notes?

The scope change has a supporting quote ('changed from 30 days to 90 days'); the completion notification has no supporting quote; 'export includes username' was only a discussion, not a decision.

For items without supporting quotes, the gatekeeper must follow up: Was this omitted from the meeting notes, or was it quietly changed in the documentation?
Tip

Prompts 2 and 3: Interface Description, Pre-review Self-check

Suggested time
Prompt 2: Interface Description
Below is a field table. Please draft the interface description text based on this.
Each field must come from the provided table. Do not include any fields, parameters, functions, or default values not in the table.
For value ranges not specified in the table, write 'To be supplemented'.
After writing, separately list: What content in your description appears in the field table? (The goal is zero items).
Field Table: [Paste]
Prompt 3: Pre-review Self-check
I am about to review these requirements. Please list the ten questions most likely to be asked during the review. Ask only; do not answer. Identify which questions are not answered by the requirement text itself.
Requirements: [Paste]
Every field in the API documentation must correspond to an entry in the field table; in the self-check, highlight any questions from the requirements that remain unanswered.
03

Common Deviations and Remedies

About 2 minutes

Common Deviations and Remedies

Fabricating non-existent requirement IDs or fields

Require that each item cites the original sentence; if the original sentence cannot be found, delete the item and ask for its source.

Rewrite 'review again' as a conclusion

Reiterate the rules and require a list of all changes made.

Treating implementation details as requirements

Distinguish between 'what is needed' and 'how to do it'; move implementation details to the 'to be confirmed' section.

If an extra field appears in the API documentation, verify it against the code; if it cannot be found, delete it.
04

Quiz and Submission

About 2 minutes

Three quick questions to check yourself

Question 1: One of the changes it lists was not discussed in the meeting. What should you do?

Answer B.The gatekeeper is a person. Every change must correspond to the exact wording from the review; if it cannot be found, delete it and ask for the source.
Show the full transcript (video narration)
Technical Documentation and Requirements Review

Welcome to Module P11 of the 'AI Implementation Course.' This lesson covers technical documentation and requirements review. The goal is to quickly obtain meeting minutes and a change list after the review, and ensure that interface descriptions keep pace with implementation. This lesson follows the rule from P06: mark what is missing, do not guess.

What You Will Take Away From This Lesson

This lesson provides three items, plus one rule. First, a requirements change list specifying what changed, what needs confirmation, the responsible person, and the deadline. Second, an interface description rule: fields can only come from the field table. Third, a conflict list between two versions of requirements. The rule is: each change must correspond to the original words in the review. These three items are materials for the 'Process' and 'Human-Machine Division of Labor' columns of the project card.

Let's Look at a Scenario

Let's look at a fictional scenario, with numbers for illustration. Product Manager He Wenqing attends three to four requirements review meetings per week, each lasting about 75 minutes. After the meeting, she needs to organize minutes and compare them with the previous version of the requirements text to list what changed and who needs to follow up. There are many versions of the requirements text, making it often unclear what was changed, and the minutes are not issued until the next day. Dragon Warrior is good at organizing text. However, it is most likely to casually add requirements, writing logically about things not discussed in the meeting. Therefore, a rule must be established: mark what is missing, do not guess.

Process: De-identify, compare two versions, humans verify item by item

The process consists of five steps. Step 1: De-sensitization. Replace feature names with codenames. Do not disclose unpublished feature details, product roadmaps, or client names. Step 2: Post the text of the old and new requirements along with review records. The output must include four columns: Change List, Items Pending Confirmation, Responsible Person, and Deadline. Step 3: Embed the rules into the prompt: Do not fill in missing items, do not treat discussions as decisions, and do not add features not present in the requirements. Step 4: Have the AI list conflicts between the two versions and note at least two possible interpretations of ambiguous statements. Step 5: Human verification. He Wenqing verifies each item one by one: Was this change actually discussed in the meeting? Items pending confirmation must not be filled in by the AI. For versions sent to clients or external parties, she approves them.

Prompt 1: Change List

Prompt 1, Change List. Input: old requirements, new requirements, and review notes. Output four sections: Change List (listing change points, old version text, new version text, and corresponding quotes from review notes); Items Pending Confirmation (written as questions); Conflicts between versions; and Ambiguous Statements (sentences with multiple interpretations). Three rules: 1. For responsible persons and deadlines not in the records, mark as 'Pending Confirmation'. 2. Do not add features not in the requirements. 3. 'Let's review again' and 'Write it this way for now' are not decisions. You must verify that each change has a corresponding quote in the review notes.

Example: Which changes have supporting quotes, and which do not?

Consider a fictional example with illustrative numbers. In the new requirements, the export range is changed from 30 days to 90 days, an in-app notification is sent upon completion, and the export content includes the username. Comparing with the review notes: The scope change has a supporting quote (discussed in the meeting as changing from 30 to 90 days); the completion notification is not mentioned in the review notes; 'export includes username' was only a discussion ('need to think about it'), not a decision. For items without supporting quotes, the gatekeeper must follow up: Was this omitted from the meeting notes, or was it quietly changed in the documentation?

Prompts 2 and 3: Interface Description, Pre-review Self-check

Prompt 2: API Documentation. Provide it with a field table, and have it draft the documentation based on that table. Every field must originate from the table; do not include any fields, parameters, or default values that are not in the table. For any unspecified value ranges, mark them as 'to be supplemented.' After drafting, it must list any content in the documentation that does not appear in the field table, with the goal of zero discrepancies. The documentation must align with the code, and the author must verify each field individually. Prompt 3: Pre-review Self-check. List the ten questions most likely to be asked during the review meeting. Ask only; do not answer. Highlight any issues that the requirements text itself does not address.

Common Deviations and Remedies

Three common deviations. First, it fabricates non-existent requirement IDs or fields. Remedy: Require each item to cite the original sentence; if the original sentence cannot be found, delete the item and ask for its source. Second, it rewrites 'review again' as a conclusion. Remedy: Reiterate the rules and require a list of all changes made. Third, it treats implementation details as requirements, such as writing 'use batch export.' Remedy: Distinguish between 'what is needed' and 'how to do it'; move implementation details to the 'to be confirmed' section. If an extra field appears in the API documentation, verify it against the code; if it cannot be found, delete it.

Quiz

Let's do a quiz. One of the changes it lists was not discussed in the meeting. What should you do? A. Keep it; it is usually correct. B. Delete it and ask for the source; every change must correspond to the exact wording from the review. C. Send it directly to the entire team. The answer is B. The gatekeeper is a person; every change must correspond to the exact wording from the review, and if it cannot be found, delete it and ask for the source.

Bring back a list that matches the original wording

This lesson has four deliverables. A change list comparing the old and new versions of the requirements, with all four columns complete; at least one instance of conflict or inconsistency between the two versions; a section of API documentation where every field can be found in the field table; and the original review wording corresponding to each change. Before submission, replace unpublished feature names with codenames; submit only the field names and meanings from the field table, not the source code. In the next lesson, we will move on to incident post-mortems and alert organization. Thank you for watching. The voiceover for this video is AI-generated.