verdicspec 0.0.0-stage → 0.2.1
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/.agents/agents/architect.md +12 -0
- package/.agents/agents/debugger.md +13 -0
- package/.agents/agents/explorer.md +16 -0
- package/.agents/agents/implementer.md +14 -0
- package/.agents/agents/observability-engineer.md +11 -0
- package/.agents/agents/planner.md +12 -0
- package/.agents/agents/pr-creator.md +11 -0
- package/.agents/agents/releaser.md +11 -0
- package/.agents/agents/reviewer.md +11 -0
- package/.agents/agents/security-reviewer.md +11 -0
- package/.agents/agents/specifier.md +14 -0
- package/.agents/agents/spike-engineer.md +12 -0
- package/.agents/agents/tester.md +12 -0
- package/.agents/agents/verifier.md +11 -0
- package/.agents/rules/agent-skill-routing.md +34 -0
- package/.agents/rules/verdicspec.md +7 -0
- package/.agents/skills/core/architecture/SKILL.md +16 -0
- package/.agents/skills/core/brownfield-analysis/SKILL.md +20 -0
- package/.agents/skills/core/debugging/SKILL.md +32 -0
- package/.agents/skills/core/planning/SKILL.md +18 -0
- package/.agents/skills/core/product-discovery/SKILL.md +20 -0
- package/.agents/skills/core/project-discovery/SKILL.md +32 -0
- package/.agents/skills/core/requirements/SKILL.md +13 -0
- package/.agents/skills/core/specification/SKILL.md +41 -0
- package/.agents/skills/core/spike/SKILL.md +30 -0
- package/.agents/skills/core/technology-discovery/SKILL.md +43 -0
- package/.agents/skills/practices/code-review/SKILL.md +21 -0
- package/.agents/skills/practices/data-migration/SKILL.md +14 -0
- package/.agents/skills/practices/observability/SKILL.md +28 -0
- package/.agents/skills/practices/observability/checklist.md +11 -0
- package/.agents/skills/practices/observability/references/dotnet.md +7 -0
- package/.agents/skills/practices/observability/references/java.md +9 -0
- package/.agents/skills/practices/observability/references/node.md +7 -0
- package/.agents/skills/practices/observability/references/python.md +7 -0
- package/.agents/skills/practices/observability/templates/logging-plan.md +16 -0
- package/.agents/skills/practices/observability/templates/metrics-plan.md +6 -0
- package/.agents/skills/practices/observability/templates/tracing-plan.md +14 -0
- package/.agents/skills/practices/pull-request/SKILL.md +17 -0
- package/.agents/skills/practices/release-readiness/SKILL.md +20 -0
- package/.agents/skills/practices/security/SKILL.md +11 -0
- package/.agents/skills/practices/testing/SKILL.md +37 -0
- package/.agents/skills/practices/verification/SKILL.md +15 -0
- package/.agents/skills/workflows/brownfield-change/SKILL.md +26 -0
- package/.agents/skills/workflows/bug-fix/SKILL.md +19 -0
- package/.agents/skills/workflows/feature-development/SKILL.md +35 -0
- package/.agents/skills/workflows/greenfield-product/SKILL.md +28 -0
- package/.claude/agents/architect.md +12 -0
- package/.claude/agents/debugger.md +13 -0
- package/.claude/agents/explorer.md +16 -0
- package/.claude/agents/implementer.md +14 -0
- package/.claude/agents/observability-engineer.md +11 -0
- package/.claude/agents/planner.md +12 -0
- package/.claude/agents/pr-creator.md +11 -0
- package/.claude/agents/releaser.md +11 -0
- package/.claude/agents/reviewer.md +11 -0
- package/.claude/agents/security-reviewer.md +11 -0
- package/.claude/agents/specifier.md +14 -0
- package/.claude/agents/spike-engineer.md +12 -0
- package/.claude/agents/tester.md +12 -0
- package/.claude/agents/verifier.md +11 -0
- package/.claude/rules/agent-skill-routing.md +34 -0
- package/.claude/rules/verdicspec.md +7 -0
- package/.claude/skills/core/architecture/SKILL.md +16 -0
- package/.claude/skills/core/brownfield-analysis/SKILL.md +20 -0
- package/.claude/skills/core/debugging/SKILL.md +32 -0
- package/.claude/skills/core/planning/SKILL.md +18 -0
- package/.claude/skills/core/product-discovery/SKILL.md +20 -0
- package/.claude/skills/core/project-discovery/SKILL.md +32 -0
- package/.claude/skills/core/requirements/SKILL.md +13 -0
- package/.claude/skills/core/specification/SKILL.md +41 -0
- package/.claude/skills/core/spike/SKILL.md +30 -0
- package/.claude/skills/core/technology-discovery/SKILL.md +43 -0
- package/.claude/skills/practices/code-review/SKILL.md +21 -0
- package/.claude/skills/practices/data-migration/SKILL.md +14 -0
- package/.claude/skills/practices/observability/SKILL.md +28 -0
- package/.claude/skills/practices/observability/checklist.md +11 -0
- package/.claude/skills/practices/observability/references/dotnet.md +7 -0
- package/.claude/skills/practices/observability/references/java.md +9 -0
- package/.claude/skills/practices/observability/references/node.md +7 -0
- package/.claude/skills/practices/observability/references/python.md +7 -0
- package/.claude/skills/practices/observability/templates/logging-plan.md +16 -0
- package/.claude/skills/practices/observability/templates/metrics-plan.md +6 -0
- package/.claude/skills/practices/observability/templates/tracing-plan.md +14 -0
- package/.claude/skills/practices/pull-request/SKILL.md +17 -0
- package/.claude/skills/practices/release-readiness/SKILL.md +20 -0
- package/.claude/skills/practices/security/SKILL.md +11 -0
- package/.claude/skills/practices/testing/SKILL.md +37 -0
- package/.claude/skills/practices/verification/SKILL.md +15 -0
- package/.claude/skills/workflows/brownfield-change/SKILL.md +26 -0
- package/.claude/skills/workflows/bug-fix/SKILL.md +19 -0
- package/.claude/skills/workflows/feature-development/SKILL.md +35 -0
- package/.claude/skills/workflows/greenfield-product/SKILL.md +28 -0
- package/.clinerules/verdicspec.md +6 -0
- package/.cursor/agents/architect.md +12 -0
- package/.cursor/agents/debugger.md +13 -0
- package/.cursor/agents/explorer.md +16 -0
- package/.cursor/agents/implementer.md +14 -0
- package/.cursor/agents/observability-engineer.md +11 -0
- package/.cursor/agents/planner.md +12 -0
- package/.cursor/agents/pr-creator.md +11 -0
- package/.cursor/agents/releaser.md +11 -0
- package/.cursor/agents/reviewer.md +11 -0
- package/.cursor/agents/security-reviewer.md +11 -0
- package/.cursor/agents/specifier.md +14 -0
- package/.cursor/agents/spike-engineer.md +12 -0
- package/.cursor/agents/tester.md +12 -0
- package/.cursor/agents/verifier.md +11 -0
- package/.cursor/rules/agent-skill-routing.mdc +34 -0
- package/.cursor/rules/verdicspec.mdc +7 -0
- package/.cursor/skills/core/architecture/SKILL.md +16 -0
- package/.cursor/skills/core/brownfield-analysis/SKILL.md +20 -0
- package/.cursor/skills/core/debugging/SKILL.md +32 -0
- package/.cursor/skills/core/planning/SKILL.md +18 -0
- package/.cursor/skills/core/product-discovery/SKILL.md +20 -0
- package/.cursor/skills/core/project-discovery/SKILL.md +32 -0
- package/.cursor/skills/core/requirements/SKILL.md +13 -0
- package/.cursor/skills/core/specification/SKILL.md +41 -0
- package/.cursor/skills/core/spike/SKILL.md +30 -0
- package/.cursor/skills/core/technology-discovery/SKILL.md +43 -0
- package/.cursor/skills/practices/code-review/SKILL.md +21 -0
- package/.cursor/skills/practices/data-migration/SKILL.md +14 -0
- package/.cursor/skills/practices/observability/SKILL.md +28 -0
- package/.cursor/skills/practices/observability/checklist.md +11 -0
- package/.cursor/skills/practices/observability/references/dotnet.md +7 -0
- package/.cursor/skills/practices/observability/references/java.md +9 -0
- package/.cursor/skills/practices/observability/references/node.md +7 -0
- package/.cursor/skills/practices/observability/references/python.md +7 -0
- package/.cursor/skills/practices/observability/templates/logging-plan.md +16 -0
- package/.cursor/skills/practices/observability/templates/metrics-plan.md +6 -0
- package/.cursor/skills/practices/observability/templates/tracing-plan.md +14 -0
- package/.cursor/skills/practices/pull-request/SKILL.md +17 -0
- package/.cursor/skills/practices/release-readiness/SKILL.md +20 -0
- package/.cursor/skills/practices/security/SKILL.md +11 -0
- package/.cursor/skills/practices/testing/SKILL.md +37 -0
- package/.cursor/skills/practices/verification/SKILL.md +15 -0
- package/.cursor/skills/workflows/brownfield-change/SKILL.md +26 -0
- package/.cursor/skills/workflows/bug-fix/SKILL.md +19 -0
- package/.cursor/skills/workflows/feature-development/SKILL.md +35 -0
- package/.cursor/skills/workflows/greenfield-product/SKILL.md +28 -0
- package/.github/copilot-instructions.md +6 -0
- package/.github/workflows/ci.yml +40 -0
- package/.github/workflows/publish.yml +32 -0
- package/.github/workflows/release.yml +104 -0
- package/.verdicspec/README.md +13 -0
- package/.verdicspec/config.json +17 -0
- package/AGENTS.md +60 -0
- package/CLAUDE.md +10 -0
- package/GEMINI.md +6 -0
- package/README.md +111 -2
- package/agents/architect.md +12 -0
- package/agents/debugger.md +13 -0
- package/agents/explorer.md +16 -0
- package/agents/implementer.md +14 -0
- package/agents/observability-engineer.md +11 -0
- package/agents/planner.md +12 -0
- package/agents/pr-creator.md +11 -0
- package/agents/releaser.md +11 -0
- package/agents/reviewer.md +11 -0
- package/agents/security-reviewer.md +11 -0
- package/agents/specifier.md +14 -0
- package/agents/spike-engineer.md +12 -0
- package/agents/tester.md +12 -0
- package/agents/verifier.md +11 -0
- package/bin/verdicspec.mjs +242 -0
- package/commands/debug.md +4 -0
- package/commands/discover.md +4 -0
- package/commands/map.md +4 -0
- package/commands/plan.md +4 -0
- package/commands/pr.md +4 -0
- package/commands/review.md +4 -0
- package/commands/specify.md +4 -0
- package/commands/spike.md +4 -0
- package/commands/verify.md +4 -0
- package/docs/artifact-contract.md +22 -0
- package/docs/commands.md +32 -0
- package/docs/method-overview.md +32 -0
- package/docs/npm-release.md +68 -0
- package/docs/portable-adapters.md +34 -0
- package/docs/project-modes.md +33 -0
- package/docs/specification-standard.md +25 -0
- package/docs/tool-support.md +24 -0
- package/docs/workflow.md +45 -0
- package/package.json +45 -4
- package/skills/core/architecture/SKILL.md +16 -0
- package/skills/core/brownfield-analysis/SKILL.md +20 -0
- package/skills/core/debugging/SKILL.md +32 -0
- package/skills/core/planning/SKILL.md +18 -0
- package/skills/core/product-discovery/SKILL.md +20 -0
- package/skills/core/project-discovery/SKILL.md +32 -0
- package/skills/core/requirements/SKILL.md +13 -0
- package/skills/core/specification/SKILL.md +41 -0
- package/skills/core/spike/SKILL.md +30 -0
- package/skills/core/technology-discovery/SKILL.md +43 -0
- package/skills/practices/code-review/SKILL.md +21 -0
- package/skills/practices/data-migration/SKILL.md +14 -0
- package/skills/practices/observability/SKILL.md +28 -0
- package/skills/practices/observability/checklist.md +11 -0
- package/skills/practices/observability/references/dotnet.md +7 -0
- package/skills/practices/observability/references/java.md +9 -0
- package/skills/practices/observability/references/node.md +7 -0
- package/skills/practices/observability/references/python.md +7 -0
- package/skills/practices/observability/templates/logging-plan.md +16 -0
- package/skills/practices/observability/templates/metrics-plan.md +6 -0
- package/skills/practices/observability/templates/tracing-plan.md +14 -0
- package/skills/practices/pull-request/SKILL.md +17 -0
- package/skills/practices/release-readiness/SKILL.md +20 -0
- package/skills/practices/security/SKILL.md +11 -0
- package/skills/practices/testing/SKILL.md +37 -0
- package/skills/practices/verification/SKILL.md +15 -0
- package/skills/workflows/brownfield-change/SKILL.md +26 -0
- package/skills/workflows/bug-fix/SKILL.md +19 -0
- package/skills/workflows/feature-development/SKILL.md +35 -0
- package/skills/workflows/greenfield-product/SKILL.md +28 -0
- package/technology-packs/dotnet/README.md +6 -0
- package/technology-packs/java/README.md +34 -0
- package/technology-packs/node/README.md +6 -0
- package/technology-packs/python/README.md +6 -0
- package/templates/brownfield-map.md +38 -0
- package/templates/bug-fix.md +36 -0
- package/templates/change-proposal.md +40 -0
- package/templates/decision-record.md +33 -0
- package/templates/feature-spec.md +50 -0
- package/templates/implementation-plan.md +33 -0
- package/templates/product-brief.md +41 -0
- package/templates/pull-request.md +27 -0
- package/templates/spike-report.md +36 -0
- package/templates/system-context.md +36 -0
- package/templates/technology-inventory.md +38 -0
- package/templates/test-plan.md +23 -0
- package/templates/threat-model.md +31 -0
- package/templates/verification-report.md +26 -0
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: feature-development
|
|
3
|
+
description: Deliver a production software feature through specification, implementation, verification, and review.
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Feature Development
|
|
7
|
+
|
|
8
|
+
First classify the work as greenfield, brownfield, or hybrid. For an existing product, use `brownfield-change`; for a new product, use `greenfield-product`. For a focused feature, use the sequence below.
|
|
9
|
+
|
|
10
|
+
1. `project-discovery` and `technology-discovery`
|
|
11
|
+
2. `specification` and `requirements`
|
|
12
|
+
3. `architecture` when boundaries or design decisions are affected
|
|
13
|
+
4. `planning`
|
|
14
|
+
5. `testing`
|
|
15
|
+
6. implementation using the selected technology pack
|
|
16
|
+
7. `observability` when operational behavior is affected
|
|
17
|
+
8. `verification`
|
|
18
|
+
9. `code-review`, `release-readiness`, and `pull-request` as applicable
|
|
19
|
+
|
|
20
|
+
## Gate conditions
|
|
21
|
+
|
|
22
|
+
- Do not implement while material requirements remain ambiguous.
|
|
23
|
+
- Do not choose a technology pack before `technology-discovery` has recorded evidence.
|
|
24
|
+
- Do not start implementation until the specification and plan are approved for the selected rigor level.
|
|
25
|
+
- Do not mark work complete without running relevant validation.
|
|
26
|
+
- Do not hide unrelated failures introduced or discovered during validation.
|
|
27
|
+
- Keep the final report tied to evidence from the repository and executed checks.
|
|
28
|
+
|
|
29
|
+
## Required outputs
|
|
30
|
+
|
|
31
|
+
- specification;
|
|
32
|
+
- implementation plan;
|
|
33
|
+
- test plan;
|
|
34
|
+
- verification report;
|
|
35
|
+
- release-readiness report when the change is deliverable.
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: greenfield-product
|
|
3
|
+
description: Shape and deliver a new software product from problem discovery through the first validated vertical slice.
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Greenfield Product
|
|
7
|
+
|
|
8
|
+
Compose `product-discovery`, `requirements`, `technology-discovery`, `architecture`, `planning`, `testing`, `observability`, `verification`, and `release-readiness` as needed.
|
|
9
|
+
|
|
10
|
+
## Sequence
|
|
11
|
+
|
|
12
|
+
1. Validate the problem, users, outcome, and non-goals.
|
|
13
|
+
2. Define the smallest useful product slice.
|
|
14
|
+
3. Record constraints, risks, and success measures.
|
|
15
|
+
4. Choose architecture and technology from evidence and expected change.
|
|
16
|
+
5. Build a vertical slice through the real boundaries.
|
|
17
|
+
6. Verify behavior and operational readiness.
|
|
18
|
+
7. Learn from feedback before expanding the product.
|
|
19
|
+
|
|
20
|
+
Do not create speculative infrastructure or broad abstractions before the first slice proves the important assumptions.
|
|
21
|
+
|
|
22
|
+
## Outputs and gates
|
|
23
|
+
|
|
24
|
+
- Discovery: `.verdicspec/product-brief.md` approved.
|
|
25
|
+
- Baseline: `.verdicspec/technology-inventory.md` and `.verdicspec/system-context.md` available.
|
|
26
|
+
- Specification: requirements and acceptance criteria approved.
|
|
27
|
+
- Delivery: vertical slice verified with an explicit release decision.
|
|
28
|
+
|
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
# .NET technology pack
|
|
2
|
+
|
|
3
|
+
Inspect the solution, project files, target framework, analyzers, test projects, package versions, and dependency-injection conventions before changing code.
|
|
4
|
+
|
|
5
|
+
Relevant practices: nullable reference types, async cancellation, options validation, structured logging, API contracts, migration safety, and test isolation.
|
|
6
|
+
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
# Java technology pack
|
|
2
|
+
|
|
3
|
+
## Discovery
|
|
4
|
+
|
|
5
|
+
Inspect `pom.xml`, `build.gradle`, `build.gradle.kts`, `gradlew`, `settings.gradle*`, Java toolchain declarations, module descriptors, test configuration, and CI before changing code.
|
|
6
|
+
|
|
7
|
+
Determine whether the project uses Java, Kotlin, or both, and identify the active build tool: Maven or Gradle. Do not assume Spring just because the project is Java.
|
|
8
|
+
|
|
9
|
+
## Engineering guidance
|
|
10
|
+
|
|
11
|
+
- Preserve the project's package, module, naming, and dependency-injection conventions.
|
|
12
|
+
- Respect the declared Java toolchain and compiler flags.
|
|
13
|
+
- Handle checked exceptions, resource ownership, interruption, and cancellation intentionally.
|
|
14
|
+
- Avoid blocking calls in reactive or asynchronous code paths.
|
|
15
|
+
- Keep public API and serialization changes backward compatible unless the specification says otherwise.
|
|
16
|
+
- Use immutable values and explicit nullability conventions where the project already supports them.
|
|
17
|
+
|
|
18
|
+
## Validation discovery
|
|
19
|
+
|
|
20
|
+
Typical commands are project-specific. Prefer the wrapper and scripts committed by the repository:
|
|
21
|
+
|
|
22
|
+
```text
|
|
23
|
+
./mvnw test
|
|
24
|
+
./mvnw verify
|
|
25
|
+
./gradlew test
|
|
26
|
+
./gradlew check
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
Run only commands supported by the project. Inspect profiles, modules, integration-test tasks, and required services before choosing the command.
|
|
30
|
+
|
|
31
|
+
## Common ecosystems
|
|
32
|
+
|
|
33
|
+
Spring Boot, Jakarta EE, Quarkus, Micronaut, JUnit, TestNG, Mockito, Testcontainers, Hibernate, Flyway, Liquibase, and OpenTelemetry are technology signals—not defaults. Verify their actual presence before loading a specialized skill.
|
|
34
|
+
|
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
# Node.js technology pack
|
|
2
|
+
|
|
3
|
+
Inspect `package.json`, lockfiles, scripts, TypeScript configuration, test configuration, and runtime version before changing code. Use the repository's package manager and existing conventions.
|
|
4
|
+
|
|
5
|
+
Relevant practices: strict typing, async error handling, input validation, dependency boundaries, test isolation, and structured observability.
|
|
6
|
+
|
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
# Python technology pack
|
|
2
|
+
|
|
3
|
+
Inspect `pyproject.toml`, lockfiles, supported Python versions, package scripts, test configuration, typing configuration, and lint rules before changing code.
|
|
4
|
+
|
|
5
|
+
Relevant practices: explicit typing, predictable exception handling, resource cleanup, dependency boundaries, deterministic tests, and structured observability.
|
|
6
|
+
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
# Brownfield Map: <system name>
|
|
2
|
+
|
|
3
|
+
## Baseline evidence
|
|
4
|
+
|
|
5
|
+
- Repositories and branches:
|
|
6
|
+
- Build commands:
|
|
7
|
+
- Test commands:
|
|
8
|
+
- Deployment path:
|
|
9
|
+
- Runtime dependencies:
|
|
10
|
+
|
|
11
|
+
## Current behavior
|
|
12
|
+
|
|
13
|
+
### Known behavior
|
|
14
|
+
|
|
15
|
+
-
|
|
16
|
+
|
|
17
|
+
### Undocumented behavior observed
|
|
18
|
+
|
|
19
|
+
-
|
|
20
|
+
|
|
21
|
+
## Boundaries and dependencies
|
|
22
|
+
|
|
23
|
+
| Boundary | Evidence | Risk |
|
|
24
|
+
|---|---|---|
|
|
25
|
+
| | | |
|
|
26
|
+
|
|
27
|
+
## Invariants
|
|
28
|
+
|
|
29
|
+
-
|
|
30
|
+
|
|
31
|
+
## Change seams
|
|
32
|
+
|
|
33
|
+
Where can the change be made with the smallest blast radius?
|
|
34
|
+
|
|
35
|
+
## Migration and rollback notes
|
|
36
|
+
|
|
37
|
+
-
|
|
38
|
+
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
# Bug Fix: <short description>
|
|
2
|
+
|
|
3
|
+
## Symptom
|
|
4
|
+
|
|
5
|
+
What is failing, for whom, and under which conditions?
|
|
6
|
+
|
|
7
|
+
## Expected behavior
|
|
8
|
+
|
|
9
|
+
What should happen instead?
|
|
10
|
+
|
|
11
|
+
## Reproduction
|
|
12
|
+
|
|
13
|
+
Steps or a minimal automated reproducer:
|
|
14
|
+
|
|
15
|
+
1.
|
|
16
|
+
|
|
17
|
+
## Hypotheses
|
|
18
|
+
|
|
19
|
+
| Hypothesis | Evidence for | Evidence against | Priority |
|
|
20
|
+
|---|---|---|---|
|
|
21
|
+
| | | | High / Medium / Low |
|
|
22
|
+
|
|
23
|
+
## Root cause
|
|
24
|
+
|
|
25
|
+
Describe the causal chain after confirmation.
|
|
26
|
+
|
|
27
|
+
## Fix and regression protection
|
|
28
|
+
|
|
29
|
+
- Fix:
|
|
30
|
+
- Regression test:
|
|
31
|
+
|
|
32
|
+
## Verification
|
|
33
|
+
|
|
34
|
+
- Command:
|
|
35
|
+
- Result:
|
|
36
|
+
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
# Change Proposal: <change name>
|
|
2
|
+
|
|
3
|
+
## Current state
|
|
4
|
+
|
|
5
|
+
What exists now? Link the system context or brownfield map.
|
|
6
|
+
|
|
7
|
+
## Desired state
|
|
8
|
+
|
|
9
|
+
What should be different and why?
|
|
10
|
+
|
|
11
|
+
## Scope and non-goals
|
|
12
|
+
|
|
13
|
+
- In scope:
|
|
14
|
+
- Out of scope:
|
|
15
|
+
|
|
16
|
+
## Requirements
|
|
17
|
+
|
|
18
|
+
| ID | Requirement | Priority | Source |
|
|
19
|
+
|---|---|---|---|
|
|
20
|
+
| REQ-001 | | Must / Should / May | |
|
|
21
|
+
|
|
22
|
+
## Compatibility and migration
|
|
23
|
+
|
|
24
|
+
- Backward compatibility:
|
|
25
|
+
- Data migration:
|
|
26
|
+
- Rollout:
|
|
27
|
+
- Rollback:
|
|
28
|
+
|
|
29
|
+
## Alternatives
|
|
30
|
+
|
|
31
|
+
| Option | Benefits | Costs | Decision |
|
|
32
|
+
|---|---|---|---|
|
|
33
|
+
| | | | |
|
|
34
|
+
|
|
35
|
+
## Approval gate
|
|
36
|
+
|
|
37
|
+
- Decision owner:
|
|
38
|
+
- Approved:
|
|
39
|
+
- Date:
|
|
40
|
+
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
# Architecture Decision Record: <decision>
|
|
2
|
+
|
|
3
|
+
## Status
|
|
4
|
+
|
|
5
|
+
Proposed / Accepted / Superseded / Rejected
|
|
6
|
+
|
|
7
|
+
## Context
|
|
8
|
+
|
|
9
|
+
What decision is required and what constraints matter?
|
|
10
|
+
|
|
11
|
+
## Decision
|
|
12
|
+
|
|
13
|
+
State the chosen option clearly.
|
|
14
|
+
|
|
15
|
+
## Alternatives considered
|
|
16
|
+
|
|
17
|
+
-
|
|
18
|
+
|
|
19
|
+
## Consequences
|
|
20
|
+
|
|
21
|
+
### Positive
|
|
22
|
+
|
|
23
|
+
-
|
|
24
|
+
|
|
25
|
+
### Negative or accepted trade-offs
|
|
26
|
+
|
|
27
|
+
-
|
|
28
|
+
|
|
29
|
+
## Evidence and review date
|
|
30
|
+
|
|
31
|
+
- Evidence:
|
|
32
|
+
- Review when:
|
|
33
|
+
|
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
# Feature Specification: <feature name>
|
|
2
|
+
|
|
3
|
+
## Context
|
|
4
|
+
|
|
5
|
+
What problem exists today and who is affected?
|
|
6
|
+
|
|
7
|
+
## Desired outcome
|
|
8
|
+
|
|
9
|
+
What should be true after this change?
|
|
10
|
+
|
|
11
|
+
## Scope
|
|
12
|
+
|
|
13
|
+
### In scope
|
|
14
|
+
|
|
15
|
+
-
|
|
16
|
+
|
|
17
|
+
### Out of scope
|
|
18
|
+
|
|
19
|
+
-
|
|
20
|
+
|
|
21
|
+
## Constraints and invariants
|
|
22
|
+
|
|
23
|
+
-
|
|
24
|
+
|
|
25
|
+
## Requirements
|
|
26
|
+
|
|
27
|
+
### REQ-001 — <requirement>
|
|
28
|
+
|
|
29
|
+
The system MUST ...
|
|
30
|
+
|
|
31
|
+
## Acceptance criteria
|
|
32
|
+
|
|
33
|
+
### AC-001 — <criterion>
|
|
34
|
+
|
|
35
|
+
```text
|
|
36
|
+
Given <precondition>
|
|
37
|
+
When <action>
|
|
38
|
+
Then <observable result>
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
## Risks and open decisions
|
|
42
|
+
|
|
43
|
+
-
|
|
44
|
+
|
|
45
|
+
## Verification plan
|
|
46
|
+
|
|
47
|
+
| Criterion | Evidence | Status |
|
|
48
|
+
|---|---|---|
|
|
49
|
+
| AC-001 | <test, inspection, or review> | Not verified |
|
|
50
|
+
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
# Implementation Plan: <change name>
|
|
2
|
+
|
|
3
|
+
## Preconditions
|
|
4
|
+
|
|
5
|
+
- Approved specification:
|
|
6
|
+
- Required decisions:
|
|
7
|
+
- Required access or dependencies:
|
|
8
|
+
|
|
9
|
+
## Tasks
|
|
10
|
+
|
|
11
|
+
| ID | Task | Depends on | Verification | Done when |
|
|
12
|
+
|---|---|---|---|---|
|
|
13
|
+
| TASK-001 | | | | |
|
|
14
|
+
|
|
15
|
+
## Test strategy
|
|
16
|
+
|
|
17
|
+
- Unit:
|
|
18
|
+
- Integration:
|
|
19
|
+
- Contract:
|
|
20
|
+
- End-to-end:
|
|
21
|
+
- Manual or exploratory:
|
|
22
|
+
|
|
23
|
+
## Operational readiness
|
|
24
|
+
|
|
25
|
+
- Logs:
|
|
26
|
+
- Metrics:
|
|
27
|
+
- Traces:
|
|
28
|
+
- Alerts or dashboards:
|
|
29
|
+
|
|
30
|
+
## Delivery sequence
|
|
31
|
+
|
|
32
|
+
Describe the smallest safe increments and rollback points.
|
|
33
|
+
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
# Product Brief: <product name>
|
|
2
|
+
|
|
3
|
+
## Problem
|
|
4
|
+
|
|
5
|
+
Who has which problem, in what context, and why does it matter?
|
|
6
|
+
|
|
7
|
+
## Users and stakeholders
|
|
8
|
+
|
|
9
|
+
| Group | Goal | Pain | Evidence |
|
|
10
|
+
|---|---|---|---|
|
|
11
|
+
| | | | |
|
|
12
|
+
|
|
13
|
+
## Desired outcome
|
|
14
|
+
|
|
15
|
+
What measurable change should the product create?
|
|
16
|
+
|
|
17
|
+
## Non-goals
|
|
18
|
+
|
|
19
|
+
-
|
|
20
|
+
|
|
21
|
+
## Constraints
|
|
22
|
+
|
|
23
|
+
- Business:
|
|
24
|
+
- Technical:
|
|
25
|
+
- Regulatory or security:
|
|
26
|
+
- Operational:
|
|
27
|
+
|
|
28
|
+
## Smallest useful slice
|
|
29
|
+
|
|
30
|
+
Describe the smallest end-to-end capability that can validate the core assumption.
|
|
31
|
+
|
|
32
|
+
## Success measures
|
|
33
|
+
|
|
34
|
+
| Measure | Baseline | Target | How measured |
|
|
35
|
+
|---|---|---|---|
|
|
36
|
+
| | | | |
|
|
37
|
+
|
|
38
|
+
## Open questions
|
|
39
|
+
|
|
40
|
+
-
|
|
41
|
+
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
# Pull Request: <short title>
|
|
2
|
+
|
|
3
|
+
## Summary
|
|
4
|
+
|
|
5
|
+
-
|
|
6
|
+
|
|
7
|
+
## Specification
|
|
8
|
+
|
|
9
|
+
- Link or path:
|
|
10
|
+
|
|
11
|
+
## Validation
|
|
12
|
+
|
|
13
|
+
- Tests:
|
|
14
|
+
- Lint:
|
|
15
|
+
- Build:
|
|
16
|
+
- Manual checks:
|
|
17
|
+
|
|
18
|
+
## Risk and rollout
|
|
19
|
+
|
|
20
|
+
- Risk:
|
|
21
|
+
- Rollback:
|
|
22
|
+
- Observability:
|
|
23
|
+
|
|
24
|
+
## Reviewer focus
|
|
25
|
+
|
|
26
|
+
-
|
|
27
|
+
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
# Spike Report: <question>
|
|
2
|
+
|
|
3
|
+
## Question
|
|
4
|
+
|
|
5
|
+
What uncertainty must this spike resolve?
|
|
6
|
+
|
|
7
|
+
## Constraints
|
|
8
|
+
|
|
9
|
+
- Time or effort budget:
|
|
10
|
+
- Runtime or infrastructure constraints:
|
|
11
|
+
- Success criteria:
|
|
12
|
+
|
|
13
|
+
## Alternatives
|
|
14
|
+
|
|
15
|
+
-
|
|
16
|
+
|
|
17
|
+
## Experiment
|
|
18
|
+
|
|
19
|
+
Describe the smallest experiment that can produce useful evidence.
|
|
20
|
+
|
|
21
|
+
## Observations
|
|
22
|
+
|
|
23
|
+
-
|
|
24
|
+
|
|
25
|
+
## Decision
|
|
26
|
+
|
|
27
|
+
Choose, reject, defer, or mark inconclusive.
|
|
28
|
+
|
|
29
|
+
## Limitations
|
|
30
|
+
|
|
31
|
+
-
|
|
32
|
+
|
|
33
|
+
## Follow-up
|
|
34
|
+
|
|
35
|
+
If implementation is approved, create a separate feature specification.
|
|
36
|
+
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
# System Context: <system name>
|
|
2
|
+
|
|
3
|
+
## Repository and runtime inventory
|
|
4
|
+
|
|
5
|
+
- Repository structure:
|
|
6
|
+
- Entry points:
|
|
7
|
+
- Runtime and deployment:
|
|
8
|
+
- Build and test commands:
|
|
9
|
+
- Configuration and secrets:
|
|
10
|
+
|
|
11
|
+
## Components
|
|
12
|
+
|
|
13
|
+
| Component | Responsibility | Owner | Dependencies |
|
|
14
|
+
|---|---|---|---|
|
|
15
|
+
| | | | |
|
|
16
|
+
|
|
17
|
+
## External boundaries
|
|
18
|
+
|
|
19
|
+
| Boundary | Protocol or contract | Data exchanged | Failure behavior |
|
|
20
|
+
|---|---|---|---|
|
|
21
|
+
| | | | |
|
|
22
|
+
|
|
23
|
+
## Data flows
|
|
24
|
+
|
|
25
|
+
Describe the important request, event, job, and persistence flows.
|
|
26
|
+
|
|
27
|
+
## Invariants
|
|
28
|
+
|
|
29
|
+
Behavior and contracts that must not change accidentally:
|
|
30
|
+
|
|
31
|
+
-
|
|
32
|
+
|
|
33
|
+
## Unknowns and risks
|
|
34
|
+
|
|
35
|
+
-
|
|
36
|
+
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
# Technology Inventory: <project or application>
|
|
2
|
+
|
|
3
|
+
## Project scope
|
|
4
|
+
|
|
5
|
+
- Mode: Greenfield / Brownfield / Hybrid
|
|
6
|
+
- Repository or package:
|
|
7
|
+
- Date:
|
|
8
|
+
|
|
9
|
+
## Detected technologies
|
|
10
|
+
|
|
11
|
+
| Area | Technology | Version | Evidence | Confidence | Active? |
|
|
12
|
+
|---|---|---|---|---|---|
|
|
13
|
+
| Language | | | | High / Medium / Low | Yes / No |
|
|
14
|
+
| Runtime | | | | | |
|
|
15
|
+
| Framework | | | | | |
|
|
16
|
+
| Build | | | | | |
|
|
17
|
+
| Test | | | | | |
|
|
18
|
+
| Lint / Format | | | | | |
|
|
19
|
+
| Deploy | | | | | |
|
|
20
|
+
|
|
21
|
+
## Commands
|
|
22
|
+
|
|
23
|
+
| Purpose | Command | Source | Confirmed by execution? |
|
|
24
|
+
|---|---|---|---|
|
|
25
|
+
| Install | | | No |
|
|
26
|
+
| Run | | | No |
|
|
27
|
+
| Test | | | No |
|
|
28
|
+
| Lint | | | No |
|
|
29
|
+
| Build | | | No |
|
|
30
|
+
|
|
31
|
+
## Active technology packs
|
|
32
|
+
|
|
33
|
+
-
|
|
34
|
+
|
|
35
|
+
## Unknowns and next checks
|
|
36
|
+
|
|
37
|
+
-
|
|
38
|
+
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# Test Plan: <change name>
|
|
2
|
+
|
|
3
|
+
## Behavioral coverage
|
|
4
|
+
|
|
5
|
+
| Acceptance criterion | Test level | Test ID | Data or setup |
|
|
6
|
+
|---|---|---|---|
|
|
7
|
+
| AC-001 | Unit / Integration / Contract / E2E | TEST-001 | |
|
|
8
|
+
|
|
9
|
+
## Negative paths and boundaries
|
|
10
|
+
|
|
11
|
+
-
|
|
12
|
+
|
|
13
|
+
## Compatibility
|
|
14
|
+
|
|
15
|
+
- Existing behavior that must remain:
|
|
16
|
+
- Contracts that must remain compatible:
|
|
17
|
+
|
|
18
|
+
## Test execution
|
|
19
|
+
|
|
20
|
+
| Command | Environment | Result |
|
|
21
|
+
|---|---|---|
|
|
22
|
+
| | | Not run |
|
|
23
|
+
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
# Threat Model: <change or system>
|
|
2
|
+
|
|
3
|
+
## Scope
|
|
4
|
+
|
|
5
|
+
- System or change:
|
|
6
|
+
- Assets:
|
|
7
|
+
- Trust boundaries:
|
|
8
|
+
- Out of scope:
|
|
9
|
+
|
|
10
|
+
## Actors and entry points
|
|
11
|
+
|
|
12
|
+
| Actor | Entry point | Capability | Trust level |
|
|
13
|
+
|---|---|---|---|
|
|
14
|
+
| | | | |
|
|
15
|
+
|
|
16
|
+
## Threats
|
|
17
|
+
|
|
18
|
+
| ID | Threat | Asset or boundary | Likelihood | Impact | Mitigation | Residual risk |
|
|
19
|
+
|---|---|---|---|---|---|---|
|
|
20
|
+
| THR-001 | | | Low / Medium / High | Low / Medium / High | | |
|
|
21
|
+
|
|
22
|
+
## Security requirements
|
|
23
|
+
|
|
24
|
+
- SEC-001:
|
|
25
|
+
|
|
26
|
+
## Verification
|
|
27
|
+
|
|
28
|
+
- Test or check:
|
|
29
|
+
- Manual review:
|
|
30
|
+
- Remaining uncertainty:
|
|
31
|
+
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# Verification Report: <change>
|
|
2
|
+
|
|
3
|
+
## Change verified
|
|
4
|
+
|
|
5
|
+
- Specification or issue:
|
|
6
|
+
- Working tree reference:
|
|
7
|
+
|
|
8
|
+
## Checks executed
|
|
9
|
+
|
|
10
|
+
| Check | Command | Result |
|
|
11
|
+
|---|---|---|
|
|
12
|
+
| Tests | `<command>` | Passed / Failed / Not run |
|
|
13
|
+
| Lint | `<command>` | Passed / Failed / Not run |
|
|
14
|
+
| Build | `<command>` | Passed / Failed / Not run |
|
|
15
|
+
| Review | `<method>` | Passed / Findings |
|
|
16
|
+
|
|
17
|
+
## Acceptance criteria
|
|
18
|
+
|
|
19
|
+
| Criterion | Evidence | Result |
|
|
20
|
+
|---|---|---|
|
|
21
|
+
| AC-001 | | Verified / Not verified |
|
|
22
|
+
|
|
23
|
+
## Known limitations
|
|
24
|
+
|
|
25
|
+
-
|
|
26
|
+
|