aimship 0.1.0-preview.19 → 0.1.0-preview.21
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CONTRIBUTING.md +3 -3
- package/README.md +6 -4
- package/README.zh-CN.md +6 -4
- package/docs/cli.md +41 -12
- package/docs/examples.md +4 -0
- package/docs/guide.md +16 -12
- package/docs/guide.zh-CN.md +16 -12
- package/lib/approvals.mjs +47 -126
- package/lib/cli.mjs +10 -7
- package/lib/delivery.mjs +39 -37
- package/lib/documents.mjs +9 -7
- package/lib/domains.mjs +123 -0
- package/lib/execution.mjs +17 -0
- package/lib/language.mjs +2 -1
- package/lib/operations.mjs +30 -0
- package/lib/projections.mjs +73 -0
- package/lib/protocol.mjs +5 -5
- package/lib/state.mjs +30 -11
- package/lib/view.mjs +160 -92
- package/package.json +2 -2
- package/skills/aimship/SKILL.md +2 -2
- package/skills/aimship/references/core.md +21 -7
- package/skills/aimship/references/document-patterns.md +16 -2
- package/skills/aimship/references/document-review.md +2 -2
- package/skills/aimship/references/recovery.md +4 -4
- package/skills/aimship/references/review-method.md +7 -0
- package/skills/aimship/references/reviews/batch.md +21 -0
- package/skills/aimship/references/reviews/overall.md +21 -0
- package/skills/aimship/references/reviews/recheck.md +21 -0
- package/skills/aimship/references/routing.md +16 -0
- package/skills/aimship/references/sources-and-changes.md +1 -1
- package/skills/aimship/references/stages/contract.md +12 -14
- package/skills/aimship/references/stages/diagnose.md +12 -14
- package/skills/aimship/references/stages/frame.md +11 -11
- package/skills/aimship/references/stages/handoff.md +12 -12
- package/skills/aimship/references/stages/implement.md +14 -14
- package/skills/aimship/references/stages/plan.md +10 -12
- package/skills/aimship/references/stages/prototype.md +10 -14
- package/skills/aimship/references/stages/requirements.md +10 -14
- package/skills/aimship/references/stages/review.md +14 -16
- package/skills/aimship/references/stages/tech-design.md +15 -17
- package/skills/aimship/references/stages/test-design.md +10 -12
- package/skills/aimship/references/stages/verify.md +13 -13
- package/skills/aimship/references/templates/change-log.md +2 -2
- package/skills/aimship/references/templates/diagnosis.md +7 -7
- package/skills/aimship/references/templates/handoff.md +6 -6
- package/skills/aimship/references/templates/plan.md +13 -7
- package/skills/aimship/references/templates/prd.md +7 -7
- package/skills/aimship/references/templates/review.md +11 -6
- package/skills/aimship/references/templates/tech-design.md +7 -7
- package/skills/aimship/references/templates/testing.md +14 -8
|
@@ -1,12 +1,16 @@
|
|
|
1
1
|
# Design the implementation
|
|
2
2
|
|
|
3
|
-
##
|
|
3
|
+
## Inputs
|
|
4
4
|
|
|
5
|
-
Read current requirements, relevant engineering instructions
|
|
5
|
+
Read current requirements, the relevant implementation/interfaces/schema, applicable engineering instructions and any commissioned diagnosis. Apply the [shared project context and decisions](../core.md#project-context-and-decisions).
|
|
6
6
|
|
|
7
|
-
##
|
|
7
|
+
## Goal and scope
|
|
8
8
|
|
|
9
|
-
|
|
9
|
+
Explain an implementation-ready engineering approach for the approved requirement scope, with readable decisions and dependencies.
|
|
10
|
+
|
|
11
|
+
## Actions
|
|
12
|
+
|
|
13
|
+
Choose an approach grounded in the relevant current implementation and applicable conventions, explaining reuse and necessary differences without expanding into unrelated legacy cleanup. Describe concrete components, dependencies, errors/recovery, compatibility and tradeoffs. Link authoritative contracts instead of duplicating them. For database changes design the data change and the subsequent independent SQL deliverable; explain dialect/version, existing schema basis, conditions and sequence. Do not edit migration files or execute SQL without that commission.
|
|
10
14
|
|
|
11
15
|
For applicable concurrency and state changes, explain when the business constraint is checked, what enforces it and any remaining window. Keep that guarantee distinct from excluded product interactions; if the requirements leave its meaning unresolved, include the concrete question in the document with its impact, recommendation and the work that needs an answer. For example, a stock reservation may check and decrement within one transaction; an earlier availability display alone does not guarantee stock at commit.
|
|
12
16
|
|
|
@@ -14,22 +18,16 @@ For a material new database/RPC call on the critical path, describe its location
|
|
|
14
18
|
|
|
15
19
|
Use an ordered explanation for simple flows. Where cross-system calls are hard to follow, a concise architecture or sequence diagram can show transaction boundaries and cache/response order. Organize affected components into readable subsections; full-stack work benefits from backend responsibilities and frontend pages/routes, reuse, interaction states and data flow. Other work uses its actual components. Explain the design and real tradeoffs in the document, using source evidence where it helps judgment; routine investigation/self-check logs are not review prerequisites. API schemas, executable SQL and full test cases remain in their later deliverables.
|
|
16
20
|
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
The design can guide the agreed next work and correctness-affecting issues have a clear disposition. Explain the approach and outstanding choices to the user.
|
|
20
|
-
|
|
21
|
-
## Decisions and blockers
|
|
21
|
+
Investigate available schema/dialect facts directly. Missing correctness-affecting facts or material compatibility/data decisions hold the dependent design claims; nonblocking execution details may stay explicit for later work. An explicitly revised conceptual-design endpoint must retain these limitations.
|
|
22
22
|
|
|
23
|
-
|
|
23
|
+
## Outputs and result
|
|
24
24
|
|
|
25
|
-
Use
|
|
26
|
-
|
|
27
|
-
## Artifact contract
|
|
28
|
-
|
|
29
|
-
Use tech-design.md. Preserve the ordinary template headings and section order. Follow [document patterns](../document-patterns.md) and the single [artifact map](../artifact-map.json). Keep this run independent even when its document is shared. New runs need a precise result location; adopted work is not a newly executed stage.
|
|
25
|
+
Use tech-design.md.
|
|
30
26
|
|
|
31
27
|
Technical design does not require finished SQL before its review. After its approval, contract produces and presents database.sql for one target, or database-<id>.sql per independent target. No SQL for no database change.
|
|
32
28
|
|
|
33
|
-
##
|
|
29
|
+
## Completion and stop
|
|
30
|
+
|
|
31
|
+
The design can guide the agreed next work and correctness-affecting issues have a clear disposition. Explain the approach and outstanding choices to the user.
|
|
34
32
|
|
|
35
|
-
|
|
33
|
+
Self-check the selected outputs and stop for their [current-content review](../document-review.md); unchanged supplied inputs follow the shared adoption rules. Production done is separate from approval.
|
|
@@ -1,27 +1,25 @@
|
|
|
1
1
|
# Design verification
|
|
2
2
|
|
|
3
|
-
##
|
|
3
|
+
## Inputs
|
|
4
4
|
|
|
5
5
|
Read current acceptance criteria, constraints, design/contracts, independent SQL and identified risks.
|
|
6
6
|
|
|
7
|
-
##
|
|
7
|
+
## Goal and scope
|
|
8
8
|
|
|
9
|
-
|
|
9
|
+
Design appropriate checks for the current acceptance criteria and risks, without claiming execution.
|
|
10
10
|
|
|
11
|
-
##
|
|
11
|
+
## Actions
|
|
12
12
|
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
## Decisions and blockers
|
|
13
|
+
Map requirements, acceptance and risks to observable normal, boundary/error and regression checks. Reuse the project's test tools and choose methods where useful: units for logic/state, interface/integration checks for service/data collaboration, component/browser/E2E for interaction paths, targeted performance or security checks for relevant requirements/risks. Explain the choices and execution conditions; no fixed category count or coverage target. Identify tools/commands, isolated data and authorization needs. Preserve checks whose conditions are absent; distinguish what must be verified from what can run now. Implementation checks, batch/overall code review and final formal verification have distinct scopes; a mock result is not real integration evidence. State the actual project execution conditions, including a deployed test environment where needed, without inventing a universal deployment prerequisite or an Aimship deployment stage.
|
|
16
14
|
|
|
17
15
|
Missing tools or execution authority do not justify deleting a valid case. Clarify acceptance omissions through current requirements rather than measuring only test count.
|
|
18
16
|
|
|
19
|
-
|
|
17
|
+
## Outputs and result
|
|
20
18
|
|
|
21
|
-
|
|
19
|
+
Use testing.md.
|
|
22
20
|
|
|
23
|
-
|
|
21
|
+
## Completion and stop
|
|
24
22
|
|
|
25
|
-
|
|
23
|
+
The goal and material risks have appropriate checks and missing execution conditions are explicit. Complete and obtain approval of cases/coverage before the selected plan stage. Write them in testing.md; execution remains explicitly not run until verify.
|
|
26
24
|
|
|
27
|
-
|
|
25
|
+
Self-check the selected outputs and stop for their [current-content review](../document-review.md); unchanged supplied inputs follow the shared adoption rules. Production done is separate from approval.
|
|
@@ -1,27 +1,27 @@
|
|
|
1
1
|
# Execute verification
|
|
2
2
|
|
|
3
|
-
##
|
|
3
|
+
## Inputs
|
|
4
4
|
|
|
5
|
-
Read current acceptance criteria, the
|
|
5
|
+
Read current acceptance criteria and case/coverage definitions, the passing overall review of the current object, any later repair reviews and the agreed execution conditions.
|
|
6
6
|
|
|
7
|
-
##
|
|
7
|
+
## Goal and scope
|
|
8
8
|
|
|
9
|
-
Execute the agreed
|
|
9
|
+
Execute only the agreed formal verification scope after passing overall review, preserving failures and retests.
|
|
10
10
|
|
|
11
|
-
##
|
|
11
|
+
## Actions
|
|
12
12
|
|
|
13
|
-
|
|
13
|
+
Execute the agreed checks on identified objects. Optional verification groups follow actual coverage and conditions, not implementation batches; a retest is another RUN in the same scope, not a new development batch. Local unit checks need no deployment. Preserve commands/operations, environment/data, expected assertions, actual results and sufficient evidence. Separate pass/fail/not-run/unknown. On defects repair the affected implementation, review the repair, then retest affected cases; append the new result and retain the old failure.
|
|
14
14
|
|
|
15
|
-
|
|
15
|
+
Use the agreed real environment: if this project’s formal tests require deployment to a test environment, hand over that preparation and wait until it is ready. Do not initiate deployment, add a deployment stage or impose deployment on checks that need none. Unavailable environment or authority stays explicit with a recovery action. Do not lower criteria, skip assertions or mark a case passed because a command exited successfully.
|
|
16
16
|
|
|
17
|
-
|
|
17
|
+
## Outputs and result
|
|
18
18
|
|
|
19
|
-
Use
|
|
19
|
+
Use testing.md.
|
|
20
20
|
|
|
21
|
-
|
|
21
|
+
Append formal RUN records only in testing.md’s AI-maintained execution section, citing TC numbers or adopted coverage references, the tested document version and exact objects. Submit each execution through record-run with its coverageRefs and objectKey, using per-coverage results when they differ. The generated current summary derives from those facts; do not hand-write a competing pass/fail table. A partial retest resolves only the matching prior coverage; retain failed RUNs and cite them through historyResultRefs. Reusing a previous object’s result requires an assessment of its applicability to the specific current object, not a renamed old result. Evidence goes in .aimship/evidence/; no installation diagnostics or repeated state output in ordinary deliveries.
|
|
22
22
|
|
|
23
|
-
|
|
23
|
+
## Completion and stop
|
|
24
24
|
|
|
25
|
-
|
|
25
|
+
The agreed execution work is accounted for with traceable results. This run can end with failure or gaps; that does not make the development goal met.
|
|
26
26
|
|
|
27
|
-
|
|
27
|
+
Save the actual result, then stop at this stage boundary. Use the [shared lifecycle](../core.md#state-and-stopping) for continuation.
|
|
@@ -2,11 +2,11 @@
|
|
|
2
2
|
|
|
3
3
|
Delivery: <deliveryId from init>; document revision: <revision>.
|
|
4
4
|
|
|
5
|
-
## Important changes
|
|
5
|
+
## 1. Important changes
|
|
6
6
|
|
|
7
7
|
CHG, reason/decision source, before/after, affected IDs/objects, actions/results and remaining work. Replace guidance with actual content; explain inapplicability, never prefill a result.
|
|
8
8
|
|
|
9
|
-
## Unfinished impact handling
|
|
9
|
+
## 2. Unfinished impact handling
|
|
10
10
|
|
|
11
11
|
One decision stays one record; no edit audit. Replace guidance with actual content; explain inapplicability, never prefill a result.
|
|
12
12
|
|
|
@@ -2,31 +2,31 @@
|
|
|
2
2
|
|
|
3
3
|
Delivery: <deliveryId from init>; document revision: <revision>.
|
|
4
4
|
|
|
5
|
-
## Investigation goal and scope
|
|
5
|
+
## 1. Investigation goal and scope
|
|
6
6
|
|
|
7
7
|
Commission and authorized scope. Replace guidance with actual content; explain inapplicability, never prefill a result.
|
|
8
8
|
|
|
9
|
-
## Observed and expected behavior
|
|
9
|
+
## 2. Observed and expected behavior
|
|
10
10
|
|
|
11
11
|
Facts versus hypotheses. Replace guidance with actual content; explain inapplicability, never prefill a result.
|
|
12
12
|
|
|
13
|
-
## Environment and reproduction
|
|
13
|
+
## 3. Environment and reproduction
|
|
14
14
|
|
|
15
15
|
Exact versions and reproducible conditions. Replace guidance with actual content; explain inapplicability, never prefill a result.
|
|
16
16
|
|
|
17
|
-
## Checks and evidence
|
|
17
|
+
## 4. Checks and evidence
|
|
18
18
|
|
|
19
19
|
Operations, observations and source refs. Replace guidance with actual content; explain inapplicability, never prefill a result.
|
|
20
20
|
|
|
21
|
-
## Cause assessment
|
|
21
|
+
## 5. Cause assessment
|
|
22
22
|
|
|
23
23
|
Confirmed causes versus unverified hypotheses. Replace guidance with actual content; explain inapplicability, never prefill a result.
|
|
24
24
|
|
|
25
|
-
## Impact and unknowns
|
|
25
|
+
## 6. Impact and unknowns
|
|
26
26
|
|
|
27
27
|
Dependent work and recovery conditions. Replace guidance with actual content; explain inapplicability, never prefill a result.
|
|
28
28
|
|
|
29
|
-
## Conclusion and next action
|
|
29
|
+
## 7. Conclusion and next action
|
|
30
30
|
|
|
31
31
|
Investigation endpoint is not automatically repair completion. Replace guidance with actual content; explain inapplicability, never prefill a result.
|
|
32
32
|
|
|
@@ -2,27 +2,27 @@
|
|
|
2
2
|
|
|
3
3
|
Delivery: <deliveryId from init>; document revision: <revision>.
|
|
4
4
|
|
|
5
|
-
## Current goal comparison
|
|
5
|
+
## 1. Current goal comparison
|
|
6
6
|
|
|
7
7
|
REQ/AC and actual results, including explicit goal changes. Replace guidance with actual content; explain inapplicability, never prefill a result.
|
|
8
8
|
|
|
9
|
-
## Artifacts, repositories and versions
|
|
9
|
+
## 2. Artifacts, repositories and versions
|
|
10
10
|
|
|
11
11
|
Links, actual checkout/worktree, branch/commit and uncommitted paths; no Git uses file digests. Replace guidance with actual content; explain inapplicability, never prefill a result.
|
|
12
12
|
|
|
13
|
-
## Usage
|
|
13
|
+
## 3. Usage
|
|
14
14
|
|
|
15
15
|
Actual commands and entry points. Replace guidance with actual content; explain inapplicability, never prefill a result.
|
|
16
16
|
|
|
17
|
-
## Review and verification
|
|
17
|
+
## 4. Review and verification
|
|
18
18
|
|
|
19
19
|
Scopes, versions, results and evidence. Replace guidance with actual content; explain inapplicability, never prefill a result.
|
|
20
20
|
|
|
21
|
-
## Limitations and remaining work
|
|
21
|
+
## 5. Limitations and remaining work
|
|
22
22
|
|
|
23
23
|
Unverified work and recovery conditions. Replace guidance with actual content; explain inapplicability, never prefill a result.
|
|
24
24
|
|
|
25
|
-
## Acceptance, integration, release and continuation
|
|
25
|
+
## 6. Acceptance, integration, release and continuation
|
|
26
26
|
|
|
27
27
|
Independent facts; prepared version is not a release. Replace guidance with actual content; explain inapplicability, never prefill a result.
|
|
28
28
|
|
|
@@ -2,27 +2,33 @@
|
|
|
2
2
|
|
|
3
3
|
Delivery: <deliveryId from init>; document revision: <revision>.
|
|
4
4
|
|
|
5
|
-
## Implementation basis and scope
|
|
5
|
+
## 1. Implementation basis and scope
|
|
6
6
|
|
|
7
7
|
Current requirements, design, contracts and actual repositories. Replace guidance with actual content; explain inapplicability, never prefill a result.
|
|
8
8
|
|
|
9
|
-
## Batches and dependencies
|
|
9
|
+
## 2. Batches and dependencies
|
|
10
10
|
|
|
11
11
|
B ID, goal, dependencies and integration arrangement. Replace guidance with actual content; explain inapplicability, never prefill a result.
|
|
12
12
|
|
|
13
|
-
## Tasks and completion criteria
|
|
13
|
+
## 3. Tasks and completion criteria
|
|
14
14
|
|
|
15
15
|
TASK, batch, REQ/AC or risk, repository ID, file/module, planned change and completion criteria. Replace guidance with actual content; explain inapplicability, never prefill a result.
|
|
16
16
|
|
|
17
|
-
## Review and independent verification arrangement
|
|
17
|
+
## 4. Review and independent verification arrangement
|
|
18
18
|
|
|
19
19
|
Each batch review, overall review then independent verification; no per-batch full test gates. Replace guidance with actual content; explain inapplicability, never prefill a result.
|
|
20
20
|
|
|
21
|
-
## Task status and execution records
|
|
21
|
+
## 5. Task status and execution records
|
|
22
22
|
|
|
23
|
-
|
|
23
|
+
### 5.1 Current batch progress (generated)
|
|
24
24
|
|
|
25
|
-
|
|
25
|
+
Pending state generation.
|
|
26
|
+
|
|
27
|
+
### 5.2 Execution notes and history
|
|
28
|
+
|
|
29
|
+
Keep necessary dated implementation/development-check notes, exact object versions, deviations and existing evidence references here. The state-generated table above is the only current batch progress table; submit implementation, review and repair facts through the state tool instead of editing its cells. Preserve approved B/TASK definitions in the design sections above and distinguish pre-existing changes. Do not write a formal self-test report for every batch or copy review findings and formal RUN results here. Replace guidance with actual content; never prefill a result.
|
|
30
|
+
|
|
31
|
+
## 6. Deviations, blockers and remaining work
|
|
26
32
|
|
|
27
33
|
Unfinished effects and recovery, not a second stage ledger. Replace guidance with actual content; explain inapplicability, never prefill a result.
|
|
28
34
|
|
|
@@ -2,31 +2,31 @@
|
|
|
2
2
|
|
|
3
3
|
Delivery: <deliveryId from init>; document revision: <revision>.
|
|
4
4
|
|
|
5
|
-
## Document information and sources
|
|
5
|
+
## 1. Document information and sources
|
|
6
6
|
|
|
7
7
|
Identify this delivery, revision and adopted inputs. Replace guidance with actual content; explain inapplicability, never prefill a result.
|
|
8
8
|
|
|
9
|
-
## Background, goals and non-goals
|
|
9
|
+
## 2. Background, goals and non-goals
|
|
10
10
|
|
|
11
11
|
Separate known facts, requirements and assumptions. Replace guidance with actual content; explain inapplicability, never prefill a result.
|
|
12
12
|
|
|
13
|
-
## Scope and delivery endpoint
|
|
13
|
+
## 3. Scope and delivery endpoint
|
|
14
14
|
|
|
15
15
|
Included/excluded business work, source correspondence, authorization and endpoint. Keep engineering dirty lists in existing engineering records, not this PRD. Replace guidance with actual content; explain inapplicability, never prefill a result.
|
|
16
16
|
|
|
17
|
-
## Requirements and behavior
|
|
17
|
+
## 4. Requirements and behavior
|
|
18
18
|
|
|
19
19
|
REQ (or retained source business ID), type, actor/object, trigger/precondition, behavior, observable result, boundaries/errors, source and AC. Shared business rules, access control (even one role), performance and reliability need independent identity when independently testable. Replace guidance with actual content; explain inapplicability, never prefill a result.
|
|
20
20
|
|
|
21
|
-
## States, interaction and recovery
|
|
21
|
+
## 5. States, interaction and recovery
|
|
22
22
|
|
|
23
23
|
Allowed transitions, terminal states, errors and recovery; say why inapplicable. Replace guidance with actual content; explain inapplicability, never prefill a result.
|
|
24
24
|
|
|
25
|
-
## Acceptance criteria
|
|
25
|
+
## 6. Acceptance criteria
|
|
26
26
|
|
|
27
27
|
AC, requirement reference, condition, operation, decidable expected result. Replace guidance with actual content; explain inapplicability, never prefill a result.
|
|
28
28
|
|
|
29
|
-
## Dependencies, questions and stage arrangement
|
|
29
|
+
## 7. Dependencies, questions and stage arrangement
|
|
30
30
|
|
|
31
31
|
Selected order, artifact locations/reuse, dependencies, Q with impact/status/decision source. Replace guidance with actual content; explain inapplicability, never prefill a result.
|
|
32
32
|
|
|
@@ -2,22 +2,27 @@
|
|
|
2
2
|
|
|
3
3
|
Delivery: <deliveryId from init>; document revision: <revision>.
|
|
4
4
|
|
|
5
|
-
## Review basis and scope
|
|
5
|
+
## 1. Review basis and scope
|
|
6
|
+
|
|
7
|
+
### 1.1 Current review (generated)
|
|
8
|
+
|
|
9
|
+
Pending state generation.
|
|
10
|
+
|
|
11
|
+
### 1.2 Review basis
|
|
6
12
|
|
|
7
13
|
State the requirements/design/plan references and review scope. Put each review's actual repositories, baseline plus differences, reviewer and date with its REV record. Keep object details readable and link the exact manifest when useful. Replace guidance with actual content; never prefill a result.
|
|
8
14
|
|
|
9
|
-
## Review records
|
|
15
|
+
## 2. Review records
|
|
10
16
|
|
|
11
17
|
Use a separate REV subsection for each batch, overall or repair review. Within it write:
|
|
12
18
|
|
|
13
19
|
- Scope and object: B/TASK and relevant REQ/AC, repositories/baseline/differences, reviewer and date.
|
|
14
20
|
- Assessment: requirements/contract consistency and code quality in this scope; reference relevant checks without repeating implementation or test-command logs.
|
|
15
|
-
- Findings: Finding | Severity/impact | File/section/symbol | Problem and basis | Disposition/status. Use a readable local finding label when a repair/recheck needs to refer back to it. If no findings,
|
|
21
|
+
- Findings: Finding | Severity/impact | File/section/symbol | Problem and basis | Disposition/status. Use a readable local finding label when a repair/recheck needs to refer back to it. If no findings, state the reviewed scope/object and brief passing conclusion without an empty table or a command transcript.
|
|
16
22
|
- Repairs and recheck: associate each finding with the actual change, rechecked object and conclusion; distinguish resolved, open and explicitly deferred work.
|
|
17
23
|
|
|
18
24
|
Keep overall review separate from batch records. Replace guidance with actual content; never prefill a result.
|
|
19
25
|
|
|
20
|
-
## Open findings and current conclusion
|
|
21
|
-
|
|
22
|
-
Maintain the latest effective conclusion: reviewed scope/object, remaining findings and whether they block continuation. Distinguish review findings from unexecuted validation, linking testing.md for runtime coverage and missing conditions. Historical conclusions remain inside their REV records for the old objects; do not accumulate obsolete “next batch” instructions here. Review is not runtime validation or user acceptance. Replace guidance with actual content; never prefill a result.
|
|
26
|
+
## 3. Open findings and current conclusion
|
|
23
27
|
|
|
28
|
+
Explain remaining findings and whether they block continuation, citing their REV records and disposition. The generated current review section above owns the effective result summary; do not create a second current-status table or accumulate obsolete “next batch” instructions here. Distinguish review findings from unexecuted validation and link testing.md for runtime coverage and missing conditions. Historical conclusions remain inside their REV records for the old objects. Review is not runtime validation or user acceptance. Replace guidance with actual content; never prefill a result.
|
|
@@ -2,31 +2,31 @@
|
|
|
2
2
|
|
|
3
3
|
Delivery: <deliveryId from init>; document revision: <revision>.
|
|
4
4
|
|
|
5
|
-
## Basis and engineering context
|
|
5
|
+
## 1. Basis and engineering context
|
|
6
6
|
|
|
7
7
|
Current requirements and actual engineering constraints. Replace guidance with actual content; explain inapplicability, never prefill a result.
|
|
8
8
|
|
|
9
|
-
## Architecture and key flows
|
|
9
|
+
## 2. Architecture and key flows
|
|
10
10
|
|
|
11
11
|
Ordered explanation, with a concise diagram when useful to show cross-system calls, transaction boundaries and cache/response order. Replace guidance with actual content; explain inapplicability, never prefill a result.
|
|
12
12
|
|
|
13
|
-
## Modules and interaction implementation
|
|
13
|
+
## 3. Modules and interaction implementation
|
|
14
14
|
|
|
15
15
|
Repository ID, responsibility, actual path, new/change and requirement refs. For a full-stack change use readable backend/frontend subsections: affected service/data responsibilities; client pages/routes, reused/new components, interaction states and data flow. For other tasks organize by the actual components; do not invent unused frontend/backend sections. Replace guidance with actual content; explain inapplicability, never prefill a result.
|
|
16
16
|
|
|
17
|
-
## Data, interfaces and SQL
|
|
17
|
+
## 4. Data, interfaces and SQL
|
|
18
18
|
|
|
19
19
|
Structures, indexes, consistency constraints and their decision time/enforcement boundary/remaining windows, contract authority, database type/version/schema basis, SQL order and execution boundary. Replace guidance with actual content; explain inapplicability, never prefill a result.
|
|
20
20
|
|
|
21
|
-
## Errors and nonfunctional design
|
|
21
|
+
## 5. Errors and nonfunctional design
|
|
22
22
|
|
|
23
23
|
Recovery, access, performance, observability, cache/messages when relevant. For critical-path changes, show call placement/count, timeout/failure behavior, cost basis and a suitable verification method; distinguish facts, estimates and unknowns. Replace guidance with actual content; explain inapplicability, never prefill a result.
|
|
24
24
|
|
|
25
|
-
## Tradeoffs and risks
|
|
25
|
+
## 6. Tradeoffs and risks
|
|
26
26
|
|
|
27
27
|
Reasons, meaningful alternatives, compatibility and remaining risks. Keep business guarantees distinct from product exclusions; explain any unresolved meaning as a concrete question. Replace guidance with actual content; explain inapplicability, never prefill a result.
|
|
28
28
|
|
|
29
|
-
## Requirement coverage and questions
|
|
29
|
+
## 7. Requirement coverage and questions
|
|
30
30
|
|
|
31
31
|
REQ/AC to module/operation/SQL section. For unresolved business or technical questions, state the impact, recommendation and latest point needing an answer. Review these with the document; carry forward questions that do not affect the next work. Replace guidance with actual content; explain inapplicability, never prefill a result.
|
|
32
32
|
|
|
@@ -2,28 +2,34 @@
|
|
|
2
2
|
|
|
3
3
|
Delivery: <deliveryId from init>; document revision: <revision>.
|
|
4
4
|
|
|
5
|
-
## Basis and scope
|
|
5
|
+
## 1. Basis and scope
|
|
6
6
|
|
|
7
7
|
Current AC and risks; adopted cases location/version if verify-only. Replace guidance with actual content; explain inapplicability, never prefill a result.
|
|
8
8
|
|
|
9
|
-
## Environment, data and execution conditions
|
|
9
|
+
## 2. Environment, data and execution conditions
|
|
10
10
|
|
|
11
11
|
Planned tools/entry commands, isolated data, permissions and unavailable execution conditions. Actual versions/environment belong with each RUN. Replace guidance with actual content; explain inapplicability, never prefill a result.
|
|
12
12
|
|
|
13
|
-
## Test cases
|
|
13
|
+
## 3. Test cases
|
|
14
14
|
|
|
15
15
|
TC, REQ/AC or risk, type/level, preconditions, operations, concrete expected result, method/entry. Replace guidance with actual content; explain inapplicability, never prefill a result.
|
|
16
16
|
|
|
17
|
-
## Coverage and verification arrangement
|
|
17
|
+
## 4. Coverage and verification arrangement
|
|
18
18
|
|
|
19
19
|
AC, requirements, TC, gaps and execution group/order. Explain the selected test methods from requirements and risk, reusing project checks; do not require every test category. Replace guidance with actual content; never prefill a result.
|
|
20
20
|
|
|
21
|
-
## Execution and retest records
|
|
21
|
+
## 5. Execution and retest records
|
|
22
22
|
|
|
23
|
-
|
|
23
|
+
### 5.1 Current verification (generated)
|
|
24
24
|
|
|
25
|
-
|
|
25
|
+
Pending state generation.
|
|
26
26
|
|
|
27
|
-
|
|
27
|
+
### 5.2 Formal runs and retests
|
|
28
|
+
|
|
29
|
+
Keep formal verification RUNs and retests here, grouped by actual coverage/conditions rather than development batch: TC or adopted coverage reference, testing document version, exact code/build object, environment, command/operation, assertions, result and evidence. A retest stays in the same scope with a new RUN; retain failures and later rechecks. Submit actual coverage/results and the tested object to the state tool; the generated summary above shows the effective results and remaining coverage. Development checks are brief plan execution notes/evidence references; they do not replace post-overall-review verification or fill this section as formal execution. Replace guidance with actual content; never prefill a result.
|
|
30
|
+
|
|
31
|
+
## 6. Defects, current conclusion and remaining work
|
|
32
|
+
|
|
33
|
+
Explain defects, their disposition, unavailable conditions and remaining work, citing the actual RUNs or review findings. The generated current verification section above owns the current coverage/result table; do not duplicate it here. Keep historical RUNs in the execution section and tie their conclusions to their tested objects. Replace guidance with actual content; never prefill a result.
|
|
28
34
|
|
|
29
35
|
<!-- Review guidance: retain the fixed outline. Technical design precedes interface/SQL production; test cases precede planning. Self-check and explicit document approval are separate from stage done. For plan/testing, keep execution records after execution/runs respectively. -->
|