aimship 0.1.0-preview.4 → 0.1.0-preview.7
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 +22 -0
- package/README.md +68 -23
- package/README.zh-CN.md +69 -24
- package/docs/cli.md +52 -32
- package/docs/examples.md +5 -0
- package/docs/guide.md +248 -30
- package/docs/guide.zh-CN.md +277 -0
- package/docs/installation.md +17 -110
- package/lib/cli.mjs +28 -16
- package/lib/documents.mjs +155 -0
- package/lib/migrate.mjs +77 -0
- package/lib/state.mjs +87 -21
- package/lib/view.mjs +69 -0
- package/package.json +3 -2
- package/skills/aimship/SKILL.md +1 -1
- package/skills/aimship/references/artifact-map.json +163 -0
- package/skills/aimship/references/core.md +8 -4
- package/skills/aimship/references/document-patterns.md +30 -10
- package/skills/aimship/references/hosts.md +4 -2
- package/skills/aimship/references/recovery.md +8 -0
- package/skills/aimship/references/sources-and-changes.md +6 -0
- package/skills/aimship/references/stages/contract.md +4 -0
- package/skills/aimship/references/stages/diagnose.md +6 -0
- package/skills/aimship/references/stages/frame.md +4 -0
- package/skills/aimship/references/stages/handoff.md +4 -0
- package/skills/aimship/references/stages/implement.md +6 -0
- package/skills/aimship/references/stages/plan.md +5 -1
- package/skills/aimship/references/stages/prototype.md +4 -0
- package/skills/aimship/references/stages/requirements.md +4 -0
- package/skills/aimship/references/stages/review.md +4 -0
- package/skills/aimship/references/stages/scope.md +4 -0
- package/skills/aimship/references/stages/tech-design.md +6 -0
- package/skills/aimship/references/stages/test-design.md +5 -1
- package/skills/aimship/references/stages/verify.md +6 -0
- package/skills/aimship/references/templates/change-log.md +14 -0
- package/skills/aimship/references/templates/diagnosis.md +39 -0
- package/skills/aimship/references/templates/handoff.md +34 -0
- package/skills/aimship/references/templates/plan.md +34 -0
- package/skills/aimship/references/templates/prd.md +39 -0
- package/skills/aimship/references/templates/review.md +19 -0
- package/skills/aimship/references/templates/scope.md +39 -0
- package/skills/aimship/references/templates/tech-design.md +39 -0
- package/skills/aimship/references/templates/testing.md +34 -0
|
@@ -26,3 +26,9 @@ Markdown/HTML are principal carriers, not a format whitelist. Images, screenshot
|
|
|
26
26
|
4. Review affected work and execute affected verification as required by the goal, then close the same change with its result and remaining issues.
|
|
27
27
|
|
|
28
28
|
Formatting/typo corrections do not require semantic re-review. Implementation bugs are fixed against the requirements; do not weaken the requirements to match the bug. Tools detect structural problems, not every semantic dependency. State uncertainty in the impact analysis rather than claiming complete automatic coverage.
|
|
29
|
+
|
|
30
|
+
## Location and version discipline
|
|
31
|
+
|
|
32
|
+
Preserve raw adopted versions under source/, including source/request.md. Author current requirements in prd.md or adopt authoritative material through scope.md. Formal outputs remain at the delivery root. New source versions are additional records, never replacements of adopted originals. Normal business evidence belongs in .aimship/evidence/; installation diagnostics and repeated state returns belong in product-maintainer validation, not the delivery.
|
|
33
|
+
|
|
34
|
+
Use CHG for significant changes, stable REQ/AC and exact TC versions. Retain failed RUN and historical REV records. Q closes only after its decision also reaches the affected formal text. See document-patterns for namespaces, retired IDs, split/merge mapping and structure. An explicit full export must identify its date and object/version and remain a snapshot.
|
|
@@ -17,3 +17,7 @@ The cooperating parties have an unambiguous applicable contract consistent with
|
|
|
17
17
|
A breaking interface/compatibility decision needs its proper authority. Missing consumers or schemas remain stated gaps, not fabricated agreements.
|
|
18
18
|
|
|
19
19
|
Use [the shared core](../core.md) for state, evidence and continuation rules. Record meaningful results in an artifact or referenced section; a file alone is not completion.
|
|
20
|
+
|
|
21
|
+
## Artifact contract
|
|
22
|
+
|
|
23
|
+
Use openapi.yaml or the registered authoritative contract. 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.
|
|
@@ -17,3 +17,9 @@ The investigation goal is met, or the inability to determine a cause and a concr
|
|
|
17
17
|
If the apparent small fix expands into behavior or scope changes, explain the impact before dependent implementation.
|
|
18
18
|
|
|
19
19
|
Use [the shared core](../core.md) for state, evidence and continuation rules. Record meaningful results in an artifact or referenced section; a file alone is not completion.
|
|
20
|
+
|
|
21
|
+
## Artifact contract
|
|
22
|
+
|
|
23
|
+
Use diagnosis.md. Preserve the `conclusion` section anchor. 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.
|
|
24
|
+
|
|
25
|
+
Only a commissioned independent investigation produces diagnosis.md. Known-cause bugs and normal development debugging stay within their current stage. Record an arrangement change before adding a mid-delivery investigation.
|
|
@@ -17,3 +17,7 @@ The commissioned exploration has a clear objective and its uncertainty is visibl
|
|
|
17
17
|
A missing business objective or incompatible expected outcomes needs a user decision; independent evidence gathering may continue.
|
|
18
18
|
|
|
19
19
|
Use [the shared core](../core.md) for state, evidence and continuation rules. Record meaningful results in an artifact or referenced section; a file alone is not completion.
|
|
20
|
+
|
|
21
|
+
## Artifact contract
|
|
22
|
+
|
|
23
|
+
Use the selected PRD/Scope requirement entry. Preserve the `goals` section anchor (Scope uses adoption/goals as applicable). 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.
|
|
@@ -17,3 +17,7 @@ The report honestly matches the current commissioned endpoint. Complete the deli
|
|
|
17
17
|
Showing results does not revise the endpoint. Required blocked verification means incomplete acceptance, even when code is ready. Small later corrections reopen with preserved closure; independent goals create related deliveries.
|
|
18
18
|
|
|
19
19
|
Use [the shared core](../core.md) for state, evidence and continuation rules. Record meaningful results in an artifact or referenced section; a file alone is not completion.
|
|
20
|
+
|
|
21
|
+
## Artifact contract
|
|
22
|
+
|
|
23
|
+
Use handoff.md. Preserve the `outcomes` section anchor. 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.
|
|
@@ -17,3 +17,9 @@ The planned batch is implemented and known deviations are resolved or explicitly
|
|
|
17
17
|
Expanded external behavior, data handling or authorization needs return to the relevant decision. A rejected permission remains blocked and is not retried through another host.
|
|
18
18
|
|
|
19
19
|
Use [the shared core](../core.md) for state, evidence and continuation rules. Record meaningful results in an artifact or referenced section; a file alone is not completion.
|
|
20
|
+
|
|
21
|
+
## Artifact contract
|
|
22
|
+
|
|
23
|
+
Use plan.md. Preserve the `execution` section anchor. 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.
|
|
24
|
+
|
|
25
|
+
Update TASK/B status and actual execution in the existing plan.md, preserving planned versus actual and code versions. Do not generate implementation.md.
|
|
@@ -10,10 +10,14 @@ Define executable batches, each goal and requirement coverage, dependencies, aut
|
|
|
10
10
|
|
|
11
11
|
## Continue when
|
|
12
12
|
|
|
13
|
-
Batches can be executed in order and together cover the delivery goal.
|
|
13
|
+
Batches can be executed in order and together cover the delivery goal. Every implementation, including a single small batch, requires a completed plan and plan.md before it begins.
|
|
14
14
|
|
|
15
15
|
## Decisions and blockers
|
|
16
16
|
|
|
17
17
|
A material change in scope/endpoint needs a decision; routine task splitting does not. Record the reason if changing the existing order.
|
|
18
18
|
|
|
19
19
|
Use [the shared core](../core.md) for state, evidence and continuation rules. Record meaningful results in an artifact or referenced section; a file alone is not completion.
|
|
20
|
+
|
|
21
|
+
## Artifact contract
|
|
22
|
+
|
|
23
|
+
Use plan.md. Preserve the `tasks` section anchor. 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.
|
|
@@ -17,3 +17,7 @@ The relevant interactions and states are clear and consistent with current requi
|
|
|
17
17
|
Missing visual/browser tools require an explicit unverified scope. Resolve contradictory behavior through requirements/Scope; do not silently alter external prototypes.
|
|
18
18
|
|
|
19
19
|
Use [the shared core](../core.md) for state, evidence and continuation rules. Record meaningful results in an artifact or referenced section; a file alone is not completion.
|
|
20
|
+
|
|
21
|
+
## Artifact contract
|
|
22
|
+
|
|
23
|
+
Use the registered prototype entry (new HTML: prototype/index.html). 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.
|
|
@@ -17,3 +17,7 @@ The requirements are adequate for the commissioned next work and material ambigu
|
|
|
17
17
|
Ask for business behavior, compatibility or endpoint choices that cannot be inferred. Do not invent user acceptance.
|
|
18
18
|
|
|
19
19
|
Use [the shared core](../core.md) for state, evidence and continuation rules. Record meaningful results in an artifact or referenced section; a file alone is not completion.
|
|
20
|
+
|
|
21
|
+
## Artifact contract
|
|
22
|
+
|
|
23
|
+
Use the selected PRD/Scope requirement entry. Preserve the `requirements` section anchor (Scope uses adoption/goals as applicable). 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.
|
|
@@ -17,3 +17,7 @@ The agreed scope has actually been examined and issues blocking progression are
|
|
|
17
17
|
Do not replace an agreed human review with agent review. Review cannot be reported as a running test; unrelated work need not be re-reviewed.
|
|
18
18
|
|
|
19
19
|
Use [the shared core](../core.md) for state, evidence and continuation rules. Record meaningful results in an artifact or referenced section; a file alone is not completion.
|
|
20
|
+
|
|
21
|
+
## Artifact contract
|
|
22
|
+
|
|
23
|
+
Use review.md. Preserve the `reviews` section anchor. 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.
|
|
@@ -17,3 +17,7 @@ The goal, authority and scope are clear enough for the selected next work, with
|
|
|
17
17
|
Material conflicting sources or uncertain authority needs clarification; format differences alone do not. Never choose source priority by filename or date.
|
|
18
18
|
|
|
19
19
|
Use [the shared core](../core.md) for state, evidence and continuation rules. Record meaningful results in an artifact or referenced section; a file alone is not completion.
|
|
20
|
+
|
|
21
|
+
## Artifact contract
|
|
22
|
+
|
|
23
|
+
Use the selected PRD/Scope requirement entry. Preserve the `scope` section anchor (Scope uses adoption/goals as applicable). 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.
|
|
@@ -17,3 +17,9 @@ The design can guide the agreed next work and correctness-affecting issues have
|
|
|
17
17
|
Missing schema/dialect or material compatibility/data decisions block dependent design claims. An explicitly revised conceptual-design endpoint must retain these limitations.
|
|
18
18
|
|
|
19
19
|
Use [the shared core](../core.md) for state, evidence and continuation rules. Record meaningful results in an artifact or referenced section; a file alone is not completion.
|
|
20
|
+
|
|
21
|
+
## Artifact contract
|
|
22
|
+
|
|
23
|
+
Use tech-design.md. Preserve the `coverage` section anchor. 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.
|
|
24
|
+
|
|
25
|
+
Produce database.sql for one target, or database-<id>.sql per independent target, before completing this stage. No SQL for no database change.
|
|
@@ -10,10 +10,14 @@ Map each goal/risk to observable checks: normal behavior, relevant errors/bounda
|
|
|
10
10
|
|
|
11
11
|
## Continue when
|
|
12
12
|
|
|
13
|
-
The goal and material risks have appropriate checks and missing execution conditions are explicit.
|
|
13
|
+
The goal and material risks have appropriate checks and missing execution conditions are explicit. Write cases and coverage in testing.md; execution remains explicitly not run until verify.
|
|
14
14
|
|
|
15
15
|
## Decisions and blockers
|
|
16
16
|
|
|
17
17
|
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
18
|
|
|
19
19
|
Use [the shared core](../core.md) for state, evidence and continuation rules. Record meaningful results in an artifact or referenced section; a file alone is not completion.
|
|
20
|
+
|
|
21
|
+
## Artifact contract
|
|
22
|
+
|
|
23
|
+
Use testing.md. Preserve the `cases` section anchor. 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.
|
|
@@ -17,3 +17,9 @@ The agreed execution work is accounted for with traceable results. This run can
|
|
|
17
17
|
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.
|
|
18
18
|
|
|
19
19
|
Use [the shared core](../core.md) for state, evidence and continuation rules. Record meaningful results in an artifact or referenced section; a file alone is not completion.
|
|
20
|
+
|
|
21
|
+
## Artifact contract
|
|
22
|
+
|
|
23
|
+
Use testing.md. Preserve the `runs` section anchor. 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.
|
|
24
|
+
|
|
25
|
+
Append RUN records in testing.md, referencing versioned TC and exact objects. Evidence goes in .aimship/evidence/; no installation diagnostics or repeated state output in ordinary deliveries.
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
# change-log
|
|
2
|
+
|
|
3
|
+
Delivery: <deliveryId from init>; document revision: <revision>.
|
|
4
|
+
|
|
5
|
+
<a id="changes"></a>
|
|
6
|
+
## Important changes
|
|
7
|
+
|
|
8
|
+
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.
|
|
9
|
+
|
|
10
|
+
<a id="remaining"></a>
|
|
11
|
+
## Unfinished impact handling
|
|
12
|
+
|
|
13
|
+
One decision stays one record; no edit audit. Replace guidance with actual content; explain inapplicability, never prefill a result.
|
|
14
|
+
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
# diagnosis
|
|
2
|
+
|
|
3
|
+
Delivery: <deliveryId from init>; document revision: <revision>.
|
|
4
|
+
|
|
5
|
+
<a id="goals"></a>
|
|
6
|
+
## Investigation goal and scope
|
|
7
|
+
|
|
8
|
+
Commission and authorized scope. Replace guidance with actual content; explain inapplicability, never prefill a result.
|
|
9
|
+
|
|
10
|
+
<a id="symptoms"></a>
|
|
11
|
+
## Observed and expected behavior
|
|
12
|
+
|
|
13
|
+
Facts versus hypotheses. Replace guidance with actual content; explain inapplicability, never prefill a result.
|
|
14
|
+
|
|
15
|
+
<a id="environment"></a>
|
|
16
|
+
## Environment and reproduction
|
|
17
|
+
|
|
18
|
+
Exact versions and reproducible conditions. Replace guidance with actual content; explain inapplicability, never prefill a result.
|
|
19
|
+
|
|
20
|
+
<a id="evidence"></a>
|
|
21
|
+
## Checks and evidence
|
|
22
|
+
|
|
23
|
+
Operations, observations and source refs. Replace guidance with actual content; explain inapplicability, never prefill a result.
|
|
24
|
+
|
|
25
|
+
<a id="causes"></a>
|
|
26
|
+
## Cause assessment
|
|
27
|
+
|
|
28
|
+
Confirmed causes versus unverified hypotheses. Replace guidance with actual content; explain inapplicability, never prefill a result.
|
|
29
|
+
|
|
30
|
+
<a id="unknowns"></a>
|
|
31
|
+
## Impact and unknowns
|
|
32
|
+
|
|
33
|
+
Dependent work and recovery conditions. Replace guidance with actual content; explain inapplicability, never prefill a result.
|
|
34
|
+
|
|
35
|
+
<a id="conclusion"></a>
|
|
36
|
+
## Conclusion and next action
|
|
37
|
+
|
|
38
|
+
Investigation endpoint is not automatically repair completion. Replace guidance with actual content; explain inapplicability, never prefill a result.
|
|
39
|
+
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
# handoff
|
|
2
|
+
|
|
3
|
+
Delivery: <deliveryId from init>; document revision: <revision>.
|
|
4
|
+
|
|
5
|
+
<a id="goals"></a>
|
|
6
|
+
## Current goal comparison
|
|
7
|
+
|
|
8
|
+
REQ/AC and actual results, including explicit goal changes. Replace guidance with actual content; explain inapplicability, never prefill a result.
|
|
9
|
+
|
|
10
|
+
<a id="artifacts"></a>
|
|
11
|
+
## Artifacts, repositories and versions
|
|
12
|
+
|
|
13
|
+
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.
|
|
14
|
+
|
|
15
|
+
<a id="usage"></a>
|
|
16
|
+
## Usage
|
|
17
|
+
|
|
18
|
+
Actual commands and entry points. Replace guidance with actual content; explain inapplicability, never prefill a result.
|
|
19
|
+
|
|
20
|
+
<a id="results"></a>
|
|
21
|
+
## Review and verification
|
|
22
|
+
|
|
23
|
+
Scopes, versions, results and evidence. Replace guidance with actual content; explain inapplicability, never prefill a result.
|
|
24
|
+
|
|
25
|
+
<a id="limits"></a>
|
|
26
|
+
## Limitations and remaining work
|
|
27
|
+
|
|
28
|
+
Unverified work and recovery conditions. Replace guidance with actual content; explain inapplicability, never prefill a result.
|
|
29
|
+
|
|
30
|
+
<a id="outcomes"></a>
|
|
31
|
+
## Acceptance, integration, release and continuation
|
|
32
|
+
|
|
33
|
+
Independent facts; prepared version is not a release. Replace guidance with actual content; explain inapplicability, never prefill a result.
|
|
34
|
+
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
# plan
|
|
2
|
+
|
|
3
|
+
Delivery: <deliveryId from init>; document revision: <revision>.
|
|
4
|
+
|
|
5
|
+
<a id="basis"></a>
|
|
6
|
+
## Implementation basis and scope
|
|
7
|
+
|
|
8
|
+
Current requirements, design, contracts and actual repositories. Replace guidance with actual content; explain inapplicability, never prefill a result.
|
|
9
|
+
|
|
10
|
+
<a id="batches"></a>
|
|
11
|
+
## Batches and dependencies
|
|
12
|
+
|
|
13
|
+
B ID, goal, dependencies and integration arrangement. Replace guidance with actual content; explain inapplicability, never prefill a result.
|
|
14
|
+
|
|
15
|
+
<a id="tasks"></a>
|
|
16
|
+
## Tasks and completion criteria
|
|
17
|
+
|
|
18
|
+
TASK, batch, REQ/AC or risk, repository ID, file/module, planned change, completion criteria, status, artifact ref. Replace guidance with actual content; explain inapplicability, never prefill a result.
|
|
19
|
+
|
|
20
|
+
<a id="validation"></a>
|
|
21
|
+
## Review and independent verification arrangement
|
|
22
|
+
|
|
23
|
+
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.
|
|
24
|
+
|
|
25
|
+
<a id="execution"></a>
|
|
26
|
+
## Task status and execution records
|
|
27
|
+
|
|
28
|
+
Actual changes and object versions by TASK/B; preserve original plan and distinguish pre-existing changes. Replace guidance with actual content; explain inapplicability, never prefill a result.
|
|
29
|
+
|
|
30
|
+
<a id="remaining"></a>
|
|
31
|
+
## Deviations, blockers and remaining work
|
|
32
|
+
|
|
33
|
+
Unfinished effects and recovery, not a second stage ledger. Replace guidance with actual content; explain inapplicability, never prefill a result.
|
|
34
|
+
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
# prd
|
|
2
|
+
|
|
3
|
+
Delivery: <deliveryId from init>; document revision: <revision>.
|
|
4
|
+
|
|
5
|
+
<a id="info"></a>
|
|
6
|
+
## Document information and sources
|
|
7
|
+
|
|
8
|
+
Identify this delivery, revision and adopted inputs. Replace guidance with actual content; explain inapplicability, never prefill a result.
|
|
9
|
+
|
|
10
|
+
<a id="goals"></a>
|
|
11
|
+
## Background, goals and non-goals
|
|
12
|
+
|
|
13
|
+
Separate known facts, requirements and assumptions. Replace guidance with actual content; explain inapplicability, never prefill a result.
|
|
14
|
+
|
|
15
|
+
<a id="scope"></a>
|
|
16
|
+
## Scope, engineering objects and endpoint
|
|
17
|
+
|
|
18
|
+
Included/excluded work, repository IDs, authorization and endpoint. Replace guidance with actual content; explain inapplicability, never prefill a result.
|
|
19
|
+
|
|
20
|
+
<a id="requirements"></a>
|
|
21
|
+
## Requirements and behavior
|
|
22
|
+
|
|
23
|
+
REQ, 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.
|
|
24
|
+
|
|
25
|
+
<a id="states"></a>
|
|
26
|
+
## States, interaction and recovery
|
|
27
|
+
|
|
28
|
+
Allowed transitions, terminal states, errors and recovery; say why inapplicable. Replace guidance with actual content; explain inapplicability, never prefill a result.
|
|
29
|
+
|
|
30
|
+
<a id="acceptance"></a>
|
|
31
|
+
## Acceptance criteria
|
|
32
|
+
|
|
33
|
+
AC, requirement reference, condition, operation, decidable expected result. Replace guidance with actual content; explain inapplicability, never prefill a result.
|
|
34
|
+
|
|
35
|
+
<a id="arrangement"></a>
|
|
36
|
+
## Dependencies, questions and stage arrangement
|
|
37
|
+
|
|
38
|
+
Selected order, artifact locations/reuse, dependencies, Q with impact/status/decision source. Replace guidance with actual content; explain inapplicability, never prefill a result.
|
|
39
|
+
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# review
|
|
2
|
+
|
|
3
|
+
Delivery: <deliveryId from init>; document revision: <revision>.
|
|
4
|
+
|
|
5
|
+
<a id="basis"></a>
|
|
6
|
+
## Review basis and scope
|
|
7
|
+
|
|
8
|
+
Exact repositories/objects, baseline and differences. Replace guidance with actual content; explain inapplicability, never prefill a result.
|
|
9
|
+
|
|
10
|
+
<a id="reviews"></a>
|
|
11
|
+
## Review records
|
|
12
|
+
|
|
13
|
+
REV, batch/overall/repair scope, TASK/REQ/AC, reviewer/date, findings, dispositions and recheck conclusions. Replace guidance with actual content; explain inapplicability, never prefill a result.
|
|
14
|
+
|
|
15
|
+
<a id="conclusion"></a>
|
|
16
|
+
## Open findings and current conclusion
|
|
17
|
+
|
|
18
|
+
Preserve historical findings and old object basis; review is not execution. Replace guidance with actual content; explain inapplicability, never prefill a result.
|
|
19
|
+
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
# scope
|
|
2
|
+
|
|
3
|
+
Delivery: <deliveryId from init>; document revision: <revision>.
|
|
4
|
+
|
|
5
|
+
<a id="info"></a>
|
|
6
|
+
## Document information and source versions
|
|
7
|
+
|
|
8
|
+
Delivery identity and adopted versions. Replace guidance with actual content; explain inapplicability, never prefill a result.
|
|
9
|
+
|
|
10
|
+
<a id="goals"></a>
|
|
11
|
+
## Goal, engineering objects and endpoint
|
|
12
|
+
|
|
13
|
+
Actual repository IDs, authorized objects and endpoint. Replace guidance with actual content; explain inapplicability, never prefill a result.
|
|
14
|
+
|
|
15
|
+
<a id="adoption"></a>
|
|
16
|
+
## Source mapping and adopted scope
|
|
17
|
+
|
|
18
|
+
Source/version/original ID or section, adoption decision, requirement reference, AC and gaps; do not copy the full PRD. Replace guidance with actual content; explain inapplicability, never prefill a result.
|
|
19
|
+
|
|
20
|
+
<a id="exclusions"></a>
|
|
21
|
+
## Exclusions and constraints
|
|
22
|
+
|
|
23
|
+
Explicitly delimit this commission. Replace guidance with actual content; explain inapplicability, never prefill a result.
|
|
24
|
+
|
|
25
|
+
<a id="decisions"></a>
|
|
26
|
+
## Conflicts, gaps and supplementary decisions
|
|
27
|
+
|
|
28
|
+
Preserve sources; identify decision authority and pending source updates. Replace guidance with actual content; explain inapplicability, never prefill a result.
|
|
29
|
+
|
|
30
|
+
<a id="acceptance"></a>
|
|
31
|
+
## Acceptance basis
|
|
32
|
+
|
|
33
|
+
AC, requirement/source identity, conditions, actions and expected results. Replace guidance with actual content; explain inapplicability, never prefill a result.
|
|
34
|
+
|
|
35
|
+
<a id="arrangement"></a>
|
|
36
|
+
## Authorization, questions and stage arrangement
|
|
37
|
+
|
|
38
|
+
Selected order, artifact locations/reuse, permissions and open Q. Replace guidance with actual content; explain inapplicability, never prefill a result.
|
|
39
|
+
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
# tech-design
|
|
2
|
+
|
|
3
|
+
Delivery: <deliveryId from init>; document revision: <revision>.
|
|
4
|
+
|
|
5
|
+
<a id="basis"></a>
|
|
6
|
+
## Basis and engineering context
|
|
7
|
+
|
|
8
|
+
Current requirements and actual engineering constraints. Replace guidance with actual content; explain inapplicability, never prefill a result.
|
|
9
|
+
|
|
10
|
+
<a id="architecture"></a>
|
|
11
|
+
## Architecture and key flows
|
|
12
|
+
|
|
13
|
+
Ordered explanation or diagram of the important flow. Replace guidance with actual content; explain inapplicability, never prefill a result.
|
|
14
|
+
|
|
15
|
+
<a id="modules"></a>
|
|
16
|
+
## Modules and interaction implementation
|
|
17
|
+
|
|
18
|
+
Repository ID, responsibility, actual path, new/change, requirement refs; entry/state/data flow for interaction. Replace guidance with actual content; explain inapplicability, never prefill a result.
|
|
19
|
+
|
|
20
|
+
<a id="data"></a>
|
|
21
|
+
## Data, interfaces and SQL
|
|
22
|
+
|
|
23
|
+
Structures, indexes, consistency, contract authority, database type/version/schema basis, SQL order and execution boundary. Replace guidance with actual content; explain inapplicability, never prefill a result.
|
|
24
|
+
|
|
25
|
+
<a id="errors"></a>
|
|
26
|
+
## Errors and nonfunctional design
|
|
27
|
+
|
|
28
|
+
Recovery, access, performance, observability, cache/messages when relevant. Replace guidance with actual content; explain inapplicability, never prefill a result.
|
|
29
|
+
|
|
30
|
+
<a id="risks"></a>
|
|
31
|
+
## Tradeoffs and risks
|
|
32
|
+
|
|
33
|
+
Reasons, alternatives, compatibility and technical risks. Replace guidance with actual content; explain inapplicability, never prefill a result.
|
|
34
|
+
|
|
35
|
+
<a id="coverage"></a>
|
|
36
|
+
## Requirement coverage and questions
|
|
37
|
+
|
|
38
|
+
REQ/AC to module/operation/SQL section and unresolved Q. Replace guidance with actual content; explain inapplicability, never prefill a result.
|
|
39
|
+
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
# testing
|
|
2
|
+
|
|
3
|
+
Delivery: <deliveryId from init>; document revision: <revision>.
|
|
4
|
+
|
|
5
|
+
<a id="basis"></a>
|
|
6
|
+
## Basis and scope
|
|
7
|
+
|
|
8
|
+
Current AC and risks; adopted cases location/version if verify-only. Replace guidance with actual content; explain inapplicability, never prefill a result.
|
|
9
|
+
|
|
10
|
+
<a id="environment"></a>
|
|
11
|
+
## Environment, data and execution conditions
|
|
12
|
+
|
|
13
|
+
Tools, permissions, commands and unavailable conditions. Replace guidance with actual content; explain inapplicability, never prefill a result.
|
|
14
|
+
|
|
15
|
+
<a id="cases"></a>
|
|
16
|
+
## Test cases
|
|
17
|
+
|
|
18
|
+
TC, case version, REQ/AC or risk, type/level, preconditions, operations, concrete expected result, method/entry. Replace guidance with actual content; explain inapplicability, never prefill a result.
|
|
19
|
+
|
|
20
|
+
<a id="coverage"></a>
|
|
21
|
+
## Coverage and verification arrangement
|
|
22
|
+
|
|
23
|
+
AC, requirements, TC, gaps and execution group/order. Replace guidance with actual content; explain inapplicability, never prefill a result.
|
|
24
|
+
|
|
25
|
+
<a id="runs"></a>
|
|
26
|
+
## Execution and retest records
|
|
27
|
+
|
|
28
|
+
RUN, TC@version, exact code/build or document object, command/operation, assertions, actual results and evidence. Not executed until actually run; append failures/retests. Replace guidance with actual content; explain inapplicability, never prefill a result.
|
|
29
|
+
|
|
30
|
+
<a id="conclusion"></a>
|
|
31
|
+
## Defects, current conclusion and remaining work
|
|
32
|
+
|
|
33
|
+
Separate passed, failed, blocked and unexecuted; explain applicability after change. Replace guidance with actual content; explain inapplicability, never prefill a result.
|
|
34
|
+
|