artifact-chain-assistant 0.8.0
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/plugins/marketplace.json +20 -0
- package/.claude-plugin/marketplace.json +20 -0
- package/.claude-plugin/plugin.json +11 -0
- package/.codex-plugin/plugin.json +27 -0
- package/.github/ISSUE_TEMPLATE/bug_report.yml +26 -0
- package/.github/ISSUE_TEMPLATE/feature_request.yml +19 -0
- package/.github/pull_request_template.md +14 -0
- package/.github/workflows/ci.yml +23 -0
- package/CHANGELOG.md +196 -0
- package/CODE_OF_CONDUCT.md +11 -0
- package/CONTRIBUTING.md +24 -0
- package/EXTENDED-ARTIFACT-CATALOG.md +312 -0
- package/EXTENDED-ARTIFACT-CATALOG.zh-CN.md +289 -0
- package/INSTALL.md +1340 -0
- package/LICENSE +186 -0
- package/NOTICE +18 -0
- package/README.md +426 -0
- package/README.zh-CN.md +409 -0
- package/SECURITY.md +19 -0
- package/adapters/claude/.claude-plugin/plugin.json +11 -0
- package/adapters/claude/EXTENDED-ARTIFACT-CATALOG.md +312 -0
- package/adapters/claude/EXTENDED-ARTIFACT-CATALOG.zh-CN.md +289 -0
- package/adapters/claude/INSTALL.md +1340 -0
- package/adapters/claude/agent-methods/catalog.yaml +260 -0
- package/adapters/claude/bin/version-lock-audit.sh +21 -0
- package/adapters/claude/bin/version-lock-refresh.sh +21 -0
- package/adapters/claude/commands/version-lock-audit.md +9 -0
- package/adapters/claude/commands/version-lock-refresh.md +9 -0
- package/adapters/claude/compatibility.json +9 -0
- package/adapters/claude/hooks/hooks.json +16 -0
- package/adapters/claude/hooks/version-lock-stop.mjs +77 -0
- package/adapters/claude/schemas/artifact-workflow-profile.schema.json +72 -0
- package/adapters/claude/scripts/batch-merge.mjs +276 -0
- package/adapters/claude/scripts/batch-split.mjs +184 -0
- package/adapters/claude/scripts/check-workflow-profile.mjs +64 -0
- package/adapters/claude/scripts/doctor.mjs +44 -0
- package/adapters/claude/scripts/lib/artifact-graph-runtime.mjs +189 -0
- package/adapters/claude/scripts/lib/compatibility-policy.mjs +435 -0
- package/adapters/claude/scripts/lib/inline-yaml-parser.mjs +216 -0
- package/adapters/claude/scripts/lib/method-registry-version.mjs +7 -0
- package/adapters/claude/scripts/lib/workflow-profile.mjs +645 -0
- package/adapters/claude/scripts/run-artifact-workflow.mjs +366 -0
- package/adapters/claude/skills/artifact-audit/SKILL.md +80 -0
- package/adapters/claude/skills/artifact-batch/SKILL.md +115 -0
- package/adapters/claude/skills/artifact-chain-bootstrap/SKILL.md +343 -0
- package/adapters/claude/skills/artifact-chain-maintainer/SKILL.md +167 -0
- package/adapters/claude/skills/artifact-generate/SKILL.md +89 -0
- package/adapters/claude/skills/artifact-repair/SKILL.md +124 -0
- package/adapters/claude/skills/artifact-review/SKILL.md +122 -0
- package/adapters/claude/skills/artifact-workflow-worker/SKILL.md +90 -0
- package/adapters/claude/skills/prd-feature/SKILL.md +68 -0
- package/adapters/claude/skills/prd-feature/author/SKILL.md +92 -0
- package/adapters/claude/skills/prd-feature/references/compose.md +43 -0
- package/adapters/claude/skills/prd-feature/references/inspect.md +94 -0
- package/adapters/claude/skills/prd-feature/references/validate.md +65 -0
- package/adapters/claude/skills/prd-feature/repair/SKILL.md +135 -0
- package/adapters/claude/skills/prd-feature/review/SKILL.md +134 -0
- package/adapters/claude/skills/scenario-script/SKILL.md +76 -0
- package/adapters/claude/skills/scenario-script/author/SKILL.md +111 -0
- package/adapters/claude/skills/scenario-script/references/compose.md +43 -0
- package/adapters/claude/skills/scenario-script/references/inspect.md +105 -0
- package/adapters/claude/skills/scenario-script/references/validate.md +72 -0
- package/adapters/claude/skills/scenario-script/repair/SKILL.md +135 -0
- package/adapters/claude/skills/scenario-script/review/SKILL.md +137 -0
- package/adapters/claude/skills/where-am-i/SKILL.md +233 -0
- package/adapters/claude/templates/README.md +159 -0
- package/adapters/claude/templates/core/decision/review-checklist.md +35 -0
- package/adapters/claude/templates/core/decision/starter.md +66 -0
- package/adapters/claude/templates/core/design/review-checklist.md +41 -0
- package/adapters/claude/templates/core/design/starter.md +84 -0
- package/adapters/claude/templates/core/e2e_test/review-checklist.md +43 -0
- package/adapters/claude/templates/core/e2e_test/starter.md +70 -0
- package/adapters/claude/templates/core/feature/review-checklist.md +29 -0
- package/adapters/claude/templates/core/feature/starter.md +43 -0
- package/adapters/claude/templates/core/scenario/review-checklist.md +29 -0
- package/adapters/claude/templates/core/scenario/starter.md +57 -0
- package/adapters/claude/templates/core/test/review-checklist.md +37 -0
- package/adapters/claude/templates/core/test/starter.md +70 -0
- package/adapters/claude/templates/extended/ADOPTION-GUIDE.md +263 -0
- package/adapters/claude/templates/extended/README.md +261 -0
- package/adapters/claude/templates/extended/agent/agent_skill/review-checklist.md +51 -0
- package/adapters/claude/templates/extended/agent/agent_skill/starter.md +133 -0
- package/adapters/claude/templates/extended/agent/hook_policy/review-checklist.md +58 -0
- package/adapters/claude/templates/extended/agent/hook_policy/starter.md +134 -0
- package/adapters/claude/templates/extended/agent/prompt_packet/review-checklist.md +54 -0
- package/adapters/claude/templates/extended/agent/prompt_packet/starter.md +106 -0
- package/adapters/claude/templates/extended/contracts/api_contract/review-checklist.md +43 -0
- package/adapters/claude/templates/extended/contracts/api_contract/starter.md +92 -0
- package/adapters/claude/templates/extended/contracts/batch_job_contract/review-checklist.md +82 -0
- package/adapters/claude/templates/extended/contracts/batch_job_contract/starter.md +158 -0
- package/adapters/claude/templates/extended/contracts/cli_contract/review-checklist.md +43 -0
- package/adapters/claude/templates/extended/contracts/cli_contract/starter.md +93 -0
- package/adapters/claude/templates/extended/contracts/data_contract/review-checklist.md +45 -0
- package/adapters/claude/templates/extended/contracts/data_contract/starter.md +88 -0
- package/adapters/claude/templates/extended/contracts/integration_contract/review-checklist.md +77 -0
- package/adapters/claude/templates/extended/contracts/integration_contract/starter.md +158 -0
- package/adapters/claude/templates/extended/contracts/ipc_contract/review-checklist.md +78 -0
- package/adapters/claude/templates/extended/contracts/ipc_contract/starter.md +214 -0
- package/adapters/claude/templates/extended/contracts/report_contract/review-checklist.md +61 -0
- package/adapters/claude/templates/extended/contracts/report_contract/starter.md +97 -0
- package/adapters/claude/templates/extended/contracts/ui_contract/review-checklist.md +70 -0
- package/adapters/claude/templates/extended/contracts/ui_contract/starter.md +150 -0
- package/adapters/claude/templates/extended/domain/database_migration/review-checklist.md +51 -0
- package/adapters/claude/templates/extended/domain/database_migration/starter.md +115 -0
- package/adapters/claude/templates/extended/domain/domain_model/review-checklist.md +43 -0
- package/adapters/claude/templates/extended/domain/domain_model/starter.md +83 -0
- package/adapters/claude/templates/extended/governance/oss_compliance/review-checklist.md +51 -0
- package/adapters/claude/templates/extended/governance/oss_compliance/starter.md +84 -0
- package/adapters/claude/templates/extended/governance/publish_skill/review-checklist.md +58 -0
- package/adapters/claude/templates/extended/governance/publish_skill/starter.md +172 -0
- package/adapters/claude/templates/extended/governance/release_policy/review-checklist.md +57 -0
- package/adapters/claude/templates/extended/governance/release_policy/starter.md +131 -0
- package/adapters/claude/templates/extended/ops/deployment_manifest/review-checklist.md +51 -0
- package/adapters/claude/templates/extended/ops/deployment_manifest/starter.md +117 -0
- package/adapters/claude/templates/extended/ops/migration_plan/review-checklist.md +63 -0
- package/adapters/claude/templates/extended/ops/migration_plan/starter.md +117 -0
- package/adapters/claude/templates/extended/ops/performance_budget/review-checklist.md +50 -0
- package/adapters/claude/templates/extended/ops/performance_budget/starter.md +117 -0
- package/adapters/claude/templates/extended/ops/runbook/review-checklist.md +51 -0
- package/adapters/claude/templates/extended/ops/runbook/starter.md +101 -0
- package/adapters/claude/templates/extended/ops/security_review/review-checklist.md +56 -0
- package/adapters/claude/templates/extended/ops/security_review/starter.md +125 -0
- package/adapters/codex/.codex-plugin/plugin.json +27 -0
- package/adapters/codex/EXTENDED-ARTIFACT-CATALOG.md +312 -0
- package/adapters/codex/EXTENDED-ARTIFACT-CATALOG.zh-CN.md +289 -0
- package/adapters/codex/INSTALL.md +1340 -0
- package/adapters/codex/agent-methods/catalog.yaml +260 -0
- package/adapters/codex/compatibility.json +9 -0
- package/adapters/codex/schemas/artifact-workflow-profile.schema.json +72 -0
- package/adapters/codex/scripts/batch-merge.mjs +276 -0
- package/adapters/codex/scripts/batch-split.mjs +184 -0
- package/adapters/codex/scripts/check-workflow-profile.mjs +64 -0
- package/adapters/codex/scripts/doctor.mjs +44 -0
- package/adapters/codex/scripts/lib/artifact-graph-runtime.mjs +189 -0
- package/adapters/codex/scripts/lib/compatibility-policy.mjs +435 -0
- package/adapters/codex/scripts/lib/inline-yaml-parser.mjs +216 -0
- package/adapters/codex/scripts/lib/method-registry-version.mjs +7 -0
- package/adapters/codex/scripts/lib/workflow-profile.mjs +645 -0
- package/adapters/codex/scripts/run-artifact-workflow.mjs +366 -0
- package/adapters/codex/skills/artifact-audit/SKILL.md +80 -0
- package/adapters/codex/skills/artifact-batch/SKILL.md +115 -0
- package/adapters/codex/skills/artifact-chain-bootstrap/SKILL.md +343 -0
- package/adapters/codex/skills/artifact-chain-maintainer/SKILL.md +167 -0
- package/adapters/codex/skills/artifact-generate/SKILL.md +89 -0
- package/adapters/codex/skills/artifact-repair/SKILL.md +124 -0
- package/adapters/codex/skills/artifact-review/SKILL.md +122 -0
- package/adapters/codex/skills/artifact-workflow-worker/SKILL.md +90 -0
- package/adapters/codex/skills/prd-feature/SKILL.md +68 -0
- package/adapters/codex/skills/prd-feature/author/SKILL.md +92 -0
- package/adapters/codex/skills/prd-feature/references/compose.md +43 -0
- package/adapters/codex/skills/prd-feature/references/inspect.md +94 -0
- package/adapters/codex/skills/prd-feature/references/validate.md +65 -0
- package/adapters/codex/skills/prd-feature/repair/SKILL.md +135 -0
- package/adapters/codex/skills/prd-feature/review/SKILL.md +134 -0
- package/adapters/codex/skills/scenario-script/SKILL.md +76 -0
- package/adapters/codex/skills/scenario-script/author/SKILL.md +111 -0
- package/adapters/codex/skills/scenario-script/references/compose.md +43 -0
- package/adapters/codex/skills/scenario-script/references/inspect.md +105 -0
- package/adapters/codex/skills/scenario-script/references/validate.md +72 -0
- package/adapters/codex/skills/scenario-script/repair/SKILL.md +135 -0
- package/adapters/codex/skills/scenario-script/review/SKILL.md +137 -0
- package/adapters/codex/skills/where-am-i/SKILL.md +233 -0
- package/adapters/codex/templates/README.md +159 -0
- package/adapters/codex/templates/core/decision/review-checklist.md +35 -0
- package/adapters/codex/templates/core/decision/starter.md +66 -0
- package/adapters/codex/templates/core/design/review-checklist.md +41 -0
- package/adapters/codex/templates/core/design/starter.md +84 -0
- package/adapters/codex/templates/core/e2e_test/review-checklist.md +43 -0
- package/adapters/codex/templates/core/e2e_test/starter.md +70 -0
- package/adapters/codex/templates/core/feature/review-checklist.md +29 -0
- package/adapters/codex/templates/core/feature/starter.md +43 -0
- package/adapters/codex/templates/core/scenario/review-checklist.md +29 -0
- package/adapters/codex/templates/core/scenario/starter.md +57 -0
- package/adapters/codex/templates/core/test/review-checklist.md +37 -0
- package/adapters/codex/templates/core/test/starter.md +70 -0
- package/adapters/codex/templates/extended/ADOPTION-GUIDE.md +263 -0
- package/adapters/codex/templates/extended/README.md +261 -0
- package/adapters/codex/templates/extended/agent/agent_skill/review-checklist.md +51 -0
- package/adapters/codex/templates/extended/agent/agent_skill/starter.md +133 -0
- package/adapters/codex/templates/extended/agent/hook_policy/review-checklist.md +58 -0
- package/adapters/codex/templates/extended/agent/hook_policy/starter.md +134 -0
- package/adapters/codex/templates/extended/agent/prompt_packet/review-checklist.md +54 -0
- package/adapters/codex/templates/extended/agent/prompt_packet/starter.md +106 -0
- package/adapters/codex/templates/extended/contracts/api_contract/review-checklist.md +43 -0
- package/adapters/codex/templates/extended/contracts/api_contract/starter.md +92 -0
- package/adapters/codex/templates/extended/contracts/batch_job_contract/review-checklist.md +82 -0
- package/adapters/codex/templates/extended/contracts/batch_job_contract/starter.md +158 -0
- package/adapters/codex/templates/extended/contracts/cli_contract/review-checklist.md +43 -0
- package/adapters/codex/templates/extended/contracts/cli_contract/starter.md +93 -0
- package/adapters/codex/templates/extended/contracts/data_contract/review-checklist.md +45 -0
- package/adapters/codex/templates/extended/contracts/data_contract/starter.md +88 -0
- package/adapters/codex/templates/extended/contracts/integration_contract/review-checklist.md +77 -0
- package/adapters/codex/templates/extended/contracts/integration_contract/starter.md +158 -0
- package/adapters/codex/templates/extended/contracts/ipc_contract/review-checklist.md +78 -0
- package/adapters/codex/templates/extended/contracts/ipc_contract/starter.md +214 -0
- package/adapters/codex/templates/extended/contracts/report_contract/review-checklist.md +61 -0
- package/adapters/codex/templates/extended/contracts/report_contract/starter.md +97 -0
- package/adapters/codex/templates/extended/contracts/ui_contract/review-checklist.md +70 -0
- package/adapters/codex/templates/extended/contracts/ui_contract/starter.md +150 -0
- package/adapters/codex/templates/extended/domain/database_migration/review-checklist.md +51 -0
- package/adapters/codex/templates/extended/domain/database_migration/starter.md +115 -0
- package/adapters/codex/templates/extended/domain/domain_model/review-checklist.md +43 -0
- package/adapters/codex/templates/extended/domain/domain_model/starter.md +83 -0
- package/adapters/codex/templates/extended/governance/oss_compliance/review-checklist.md +51 -0
- package/adapters/codex/templates/extended/governance/oss_compliance/starter.md +84 -0
- package/adapters/codex/templates/extended/governance/publish_skill/review-checklist.md +58 -0
- package/adapters/codex/templates/extended/governance/publish_skill/starter.md +172 -0
- package/adapters/codex/templates/extended/governance/release_policy/review-checklist.md +57 -0
- package/adapters/codex/templates/extended/governance/release_policy/starter.md +131 -0
- package/adapters/codex/templates/extended/ops/deployment_manifest/review-checklist.md +51 -0
- package/adapters/codex/templates/extended/ops/deployment_manifest/starter.md +117 -0
- package/adapters/codex/templates/extended/ops/migration_plan/review-checklist.md +63 -0
- package/adapters/codex/templates/extended/ops/migration_plan/starter.md +117 -0
- package/adapters/codex/templates/extended/ops/performance_budget/review-checklist.md +50 -0
- package/adapters/codex/templates/extended/ops/performance_budget/starter.md +117 -0
- package/adapters/codex/templates/extended/ops/runbook/review-checklist.md +51 -0
- package/adapters/codex/templates/extended/ops/runbook/starter.md +101 -0
- package/adapters/codex/templates/extended/ops/security_review/review-checklist.md +56 -0
- package/adapters/codex/templates/extended/ops/security_review/starter.md +125 -0
- package/agent-methods/catalog.yaml +260 -0
- package/compatibility.json +9 -0
- package/package.json +85 -0
- package/runtime/claude/version-lock-stop.mjs +77 -0
- package/schemas/artifact-workflow-profile.schema.json +72 -0
- package/scripts/batch-merge.mjs +276 -0
- package/scripts/batch-split.mjs +184 -0
- package/scripts/build-adapters.mjs +195 -0
- package/scripts/build-runtime-bundles.mjs +134 -0
- package/scripts/check-compatibility.mjs +19 -0
- package/scripts/check-method-registry.mjs +461 -0
- package/scripts/check-templates.mjs +348 -0
- package/scripts/check-workflow-profile.mjs +64 -0
- package/scripts/doctor.mjs +44 -0
- package/scripts/install-git-hooks.mjs +21 -0
- package/scripts/lib/artifact-graph-runtime.mjs +189 -0
- package/scripts/lib/compatibility-policy.mjs +435 -0
- package/scripts/lib/inline-yaml-parser.mjs +216 -0
- package/scripts/lib/method-registry-version.mjs +7 -0
- package/scripts/lib/workflow-profile.mjs +645 -0
- package/scripts/run-artifact-workflow.mjs +366 -0
- package/scripts/sync-skills.mjs +149 -0
- package/skills-src/artifact-audit/SKILL.md +80 -0
- package/skills-src/artifact-batch/SKILL.md +115 -0
- package/skills-src/artifact-chain-bootstrap/SKILL.md +343 -0
- package/skills-src/artifact-chain-maintainer/SKILL.md +167 -0
- package/skills-src/artifact-generate/SKILL.md +89 -0
- package/skills-src/artifact-repair/SKILL.md +124 -0
- package/skills-src/artifact-review/SKILL.md +122 -0
- package/skills-src/artifact-workflow-worker/SKILL.md +90 -0
- package/skills-src/prd-feature/SKILL.md +68 -0
- package/skills-src/prd-feature/author/SKILL.md +92 -0
- package/skills-src/prd-feature/references/compose.md +43 -0
- package/skills-src/prd-feature/references/inspect.md +94 -0
- package/skills-src/prd-feature/references/validate.md +65 -0
- package/skills-src/prd-feature/repair/SKILL.md +135 -0
- package/skills-src/prd-feature/review/SKILL.md +134 -0
- package/skills-src/scenario-script/SKILL.md +76 -0
- package/skills-src/scenario-script/author/SKILL.md +111 -0
- package/skills-src/scenario-script/references/compose.md +43 -0
- package/skills-src/scenario-script/references/inspect.md +105 -0
- package/skills-src/scenario-script/references/validate.md +72 -0
- package/skills-src/scenario-script/repair/SKILL.md +135 -0
- package/skills-src/scenario-script/review/SKILL.md +137 -0
- package/skills-src/where-am-i/SKILL.md.tpl +233 -0
- package/templates/README.md +159 -0
- package/templates/claude/marketplace.json.tpl +20 -0
- package/templates/claude/plugin.json.tpl +11 -0
- package/templates/claude/settings.json.tpl +16 -0
- package/templates/codex/marketplace.json.tpl +20 -0
- package/templates/codex/plugin.json.tpl +27 -0
- package/templates/core/decision/review-checklist.md +35 -0
- package/templates/core/decision/starter.md +66 -0
- package/templates/core/design/review-checklist.md +41 -0
- package/templates/core/design/starter.md +84 -0
- package/templates/core/e2e_test/review-checklist.md +43 -0
- package/templates/core/e2e_test/starter.md +70 -0
- package/templates/core/feature/review-checklist.md +29 -0
- package/templates/core/feature/starter.md +43 -0
- package/templates/core/scenario/review-checklist.md +29 -0
- package/templates/core/scenario/starter.md +57 -0
- package/templates/core/test/review-checklist.md +37 -0
- package/templates/core/test/starter.md +70 -0
- package/templates/extended/ADOPTION-GUIDE.md +263 -0
- package/templates/extended/README.md +261 -0
- package/templates/extended/agent/agent_skill/review-checklist.md +51 -0
- package/templates/extended/agent/agent_skill/starter.md +133 -0
- package/templates/extended/agent/hook_policy/review-checklist.md +58 -0
- package/templates/extended/agent/hook_policy/starter.md +134 -0
- package/templates/extended/agent/prompt_packet/review-checklist.md +54 -0
- package/templates/extended/agent/prompt_packet/starter.md +106 -0
- package/templates/extended/contracts/api_contract/review-checklist.md +43 -0
- package/templates/extended/contracts/api_contract/starter.md +92 -0
- package/templates/extended/contracts/batch_job_contract/review-checklist.md +82 -0
- package/templates/extended/contracts/batch_job_contract/starter.md +158 -0
- package/templates/extended/contracts/cli_contract/review-checklist.md +43 -0
- package/templates/extended/contracts/cli_contract/starter.md +93 -0
- package/templates/extended/contracts/data_contract/review-checklist.md +45 -0
- package/templates/extended/contracts/data_contract/starter.md +88 -0
- package/templates/extended/contracts/integration_contract/review-checklist.md +77 -0
- package/templates/extended/contracts/integration_contract/starter.md +158 -0
- package/templates/extended/contracts/ipc_contract/review-checklist.md +78 -0
- package/templates/extended/contracts/ipc_contract/starter.md +214 -0
- package/templates/extended/contracts/report_contract/review-checklist.md +61 -0
- package/templates/extended/contracts/report_contract/starter.md +97 -0
- package/templates/extended/contracts/ui_contract/review-checklist.md +70 -0
- package/templates/extended/contracts/ui_contract/starter.md +150 -0
- package/templates/extended/domain/database_migration/review-checklist.md +51 -0
- package/templates/extended/domain/database_migration/starter.md +115 -0
- package/templates/extended/domain/domain_model/review-checklist.md +43 -0
- package/templates/extended/domain/domain_model/starter.md +83 -0
- package/templates/extended/governance/oss_compliance/review-checklist.md +51 -0
- package/templates/extended/governance/oss_compliance/starter.md +84 -0
- package/templates/extended/governance/publish_skill/review-checklist.md +58 -0
- package/templates/extended/governance/publish_skill/starter.md +172 -0
- package/templates/extended/governance/release_policy/review-checklist.md +57 -0
- package/templates/extended/governance/release_policy/starter.md +131 -0
- package/templates/extended/ops/deployment_manifest/review-checklist.md +51 -0
- package/templates/extended/ops/deployment_manifest/starter.md +117 -0
- package/templates/extended/ops/migration_plan/review-checklist.md +63 -0
- package/templates/extended/ops/migration_plan/starter.md +117 -0
- package/templates/extended/ops/performance_budget/review-checklist.md +50 -0
- package/templates/extended/ops/performance_budget/starter.md +117 -0
- package/templates/extended/ops/runbook/review-checklist.md +51 -0
- package/templates/extended/ops/runbook/starter.md +101 -0
- package/templates/extended/ops/security_review/review-checklist.md +56 -0
- package/templates/extended/ops/security_review/starter.md +125 -0
- package/templates/git-hooks/pre-commit.sh +43 -0
- package/templates/git-hooks/pre-push.sh +22 -0
|
@@ -0,0 +1,159 @@
|
|
|
1
|
+
# Artifact Chain Assistant 模板目录
|
|
2
|
+
|
|
3
|
+
本目录提供 `artifact-chain-assistant` 插件的 starter 模板,为目标项目提供制品结构的入门指导。
|
|
4
|
+
|
|
5
|
+
## 权威层级
|
|
6
|
+
|
|
7
|
+
**关键原则:插件模板是入门指导,项目本地模板是权威。**
|
|
8
|
+
|
|
9
|
+
| 层级 | 权威范围 | 对模板的职责 |
|
|
10
|
+
|------|---------|-------------|
|
|
11
|
+
| **插件(本目录)** | 通用助手指导 | 提供 starter 模板和通用审查清单。**模板是指导,不是权威。** |
|
|
12
|
+
| **目标项目** | 最终工作法 | 维护项目本地模板,覆盖或补充插件建议。**项目本地模板是权威。** |
|
|
13
|
+
|
|
14
|
+
当项目需要不同的章节结构、审查标准或命名规则时,项目本地模板覆盖插件模板。项目本地审查技能覆盖插件通用审查规则。
|
|
15
|
+
|
|
16
|
+
## 目录结构
|
|
17
|
+
|
|
18
|
+
```
|
|
19
|
+
templates/
|
|
20
|
+
├── core/ # 核心制品模板
|
|
21
|
+
│ ├── feature/ # 功能特性
|
|
22
|
+
│ │ ├── starter.md # 起草指引模板
|
|
23
|
+
│ │ └── review-checklist.md # 通用审查清单
|
|
24
|
+
│ ├── scenario/ # 场景
|
|
25
|
+
│ ├── decision/ # 决策
|
|
26
|
+
│ ├── design/ # 设计文档
|
|
27
|
+
│ ├── test/ # 测试
|
|
28
|
+
│ └── e2e_test/ # 端到端测试
|
|
29
|
+
│
|
|
30
|
+
├── extended/ # 扩展制品模板(按类别组织)
|
|
31
|
+
│ ├── contracts/ # 契约类制品
|
|
32
|
+
│ │ ├── api_contract/ # API 契约
|
|
33
|
+
│ │ ├── cli_contract/ # CLI 契约
|
|
34
|
+
│ │ └── data_contract/ # 数据契约
|
|
35
|
+
│ ├── domain/ # 领域与数据制品
|
|
36
|
+
│ │ └── domain_model/ # 领域模型
|
|
37
|
+
│ ├── ops/ # 部署与运维制品
|
|
38
|
+
│ │ ├── runbook/ # 运维手册
|
|
39
|
+
│ │ └── deployment_manifest/ # 部署清单
|
|
40
|
+
│ └── agent/ # Agent 与 Hook 制品
|
|
41
|
+
│ ├── agent_skill/ # Agent 技能
|
|
42
|
+
│ └── hook_policy/ # Hook 策略
|
|
43
|
+
│
|
|
44
|
+
├── git-hooks/ # Git hook 脚本模板
|
|
45
|
+
├── claude/ # Claude Code 适配器模板
|
|
46
|
+
└── codex/ # Codex 适配器模板
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
## 模板使用方式
|
|
50
|
+
|
|
51
|
+
### Bootstrap 阶段
|
|
52
|
+
|
|
53
|
+
1. `artifact-chain-bootstrap` 技能根据项目形态选择最小可用 profile
|
|
54
|
+
2. bootstrap 技能引用本目录的 starter 模板生成初始制品结构
|
|
55
|
+
3. 在 `artifacts/README.md` 中记录模板来源
|
|
56
|
+
|
|
57
|
+
### 采用阶段
|
|
58
|
+
|
|
59
|
+
1. 项目团队审阅 starter 模板
|
|
60
|
+
2. 决定哪些章节保留、哪些修改、哪些删除
|
|
61
|
+
3. 修改后的模板成为项目本地权威
|
|
62
|
+
|
|
63
|
+
### 成熟阶段
|
|
64
|
+
|
|
65
|
+
1. 项目可能在本地维护完整的模板库
|
|
66
|
+
2. 完全不再引用插件 starter
|
|
67
|
+
3. 插件 starter 仅在新成员加入或新类型启用时被参考
|
|
68
|
+
|
|
69
|
+
## 模板内容说明
|
|
70
|
+
|
|
71
|
+
### starter.md
|
|
72
|
+
|
|
73
|
+
每个类型的 `starter.md` 包含:
|
|
74
|
+
- 制品 frontmatter 结构
|
|
75
|
+
- 最小填写指引
|
|
76
|
+
- 关键章节说明
|
|
77
|
+
- 关联制品示例
|
|
78
|
+
|
|
79
|
+
**使用建议**:
|
|
80
|
+
- 复制到项目本地后修改
|
|
81
|
+
- 根据项目需求调整章节
|
|
82
|
+
- 删除不适用的章节
|
|
83
|
+
- 添加项目特定的章节
|
|
84
|
+
|
|
85
|
+
### review-checklist.md
|
|
86
|
+
|
|
87
|
+
每个类型的 `review-checklist.md` 包含:
|
|
88
|
+
- 结构完整性检查
|
|
89
|
+
- 内容质量检查
|
|
90
|
+
- 追溯性检查
|
|
91
|
+
- 生命周期检查
|
|
92
|
+
|
|
93
|
+
**使用建议**:
|
|
94
|
+
- 作为审查基线参考
|
|
95
|
+
- 根据项目标准调整检查项
|
|
96
|
+
- 添加项目特定的检查项
|
|
97
|
+
- 在审查技能中引用
|
|
98
|
+
|
|
99
|
+
## 扩展制品类型说明
|
|
100
|
+
|
|
101
|
+
### 契约类制品
|
|
102
|
+
|
|
103
|
+
记录系统边界的接口约定。当需求从功能和场景流入实现时,契约是上下文组装的关键上游。
|
|
104
|
+
|
|
105
|
+
- **api_contract**:REST/GraphQL/gRPC API 接口契约
|
|
106
|
+
- **cli_contract**:命令行工具接口契约
|
|
107
|
+
- **data_contract**:数据模型和数据质量契约
|
|
108
|
+
|
|
109
|
+
### 领域与数据制品
|
|
110
|
+
|
|
111
|
+
捕捉业务概念和技术数据模型。是企业 Java 和 DDD 项目的核心制品。
|
|
112
|
+
|
|
113
|
+
- **domain_model**:聚合、实体、值对象、领域事件
|
|
114
|
+
|
|
115
|
+
### 部署与运维制品
|
|
116
|
+
|
|
117
|
+
覆盖生产环境的变更、安全、性能和操作流程。仅当项目有对应运维流程时启用。
|
|
118
|
+
|
|
119
|
+
- **runbook**:运维操作手册
|
|
120
|
+
- **deployment_manifest**:部署配置清单
|
|
121
|
+
|
|
122
|
+
### Agent 与 Hook 制品
|
|
123
|
+
|
|
124
|
+
覆盖 AI 辅助工作流和 CI/CD 门禁。仅当项目有对应文件或流程时启用。
|
|
125
|
+
|
|
126
|
+
- **agent_skill**:Agent 技能定义
|
|
127
|
+
- **hook_policy**:Hook 策略和门禁规则
|
|
128
|
+
|
|
129
|
+
## Bootstrap 裁剪策略
|
|
130
|
+
|
|
131
|
+
bootstrap 的职责是根据项目形态选择**最小可用 profile**,而非启用所有已知类型。
|
|
132
|
+
|
|
133
|
+
裁剪规则:
|
|
134
|
+
|
|
135
|
+
1. **基础集合始终启用**:`feature`、`scenario`、`decision`、`design`、`test`、`e2e_test`
|
|
136
|
+
2. **契约类按证据加入**:仅当项目本地存在对应的接口文件时启用
|
|
137
|
+
3. **领域与数据类按项目形态加入**:企业 Java/DDD 项目可启用 `domain_model`
|
|
138
|
+
4. **运维类按运维流程加入**:仅有部署配置文件或运维手册的项目才启用对应类型
|
|
139
|
+
5. **Agent/Hook 类按本地文件加入**:仅当项目存在 `skills/`、`policies/` 或 hook 配置文件时启用
|
|
140
|
+
6. **渐进扩展**:项目随成熟度增长,可按需添加新类型
|
|
141
|
+
|
|
142
|
+
## 扩展制品目录设计
|
|
143
|
+
|
|
144
|
+
本目录的模板结构遵循扩展制品目录规范:
|
|
145
|
+
|
|
146
|
+
- 模板按类别组织(contracts、domain、ops、agent),每类含 starter 模板和审查清单
|
|
147
|
+
- 模板来源遵循权威层级:插件模板是入门指导,项目本地模板是权威
|
|
148
|
+
- Bootstrap 按项目形态裁剪,仅启用有本地证据的类型
|
|
149
|
+
- 模板生命周期:starter → 项目采用定制 → 本地权威
|
|
150
|
+
|
|
151
|
+
详细的类型目录、推荐路径、ID 模式和生命周期规则,请参考
|
|
152
|
+
[扩展制品目录](../EXTENDED-ARTIFACT-CATALOG.md)。
|
|
153
|
+
|
|
154
|
+
## 相关文档
|
|
155
|
+
|
|
156
|
+
- [扩展制品目录](../EXTENDED-ARTIFACT-CATALOG.md) - 类型分类、路径/ID 模式、生命周期规则
|
|
157
|
+
- [ADOPTION-GUIDE](extended/ADOPTION-GUIDE.md) - 模板采用与升级评审指南
|
|
158
|
+
- [INSTALL.md](../INSTALL.md) - 插件安装指南
|
|
159
|
+
- [artifact-chain-bootstrap 技能](../skills/artifact-chain-bootstrap/SKILL.md) - Bootstrap 技能文档
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
# Decision 审查清单
|
|
2
|
+
|
|
3
|
+
<!-- 本清单是插件通用基线,项目本地审查规则可覆盖 -->
|
|
4
|
+
|
|
5
|
+
## 结构完整性
|
|
6
|
+
|
|
7
|
+
- [ ] `id` 字段存在且符合项目 ID 模式(如 `D-{PREFIX}-{nn}`)
|
|
8
|
+
- [ ] `title` 字段存在且清晰表达决策主题
|
|
9
|
+
- [ ] `status` 字段存在且为有效值(proposed/accepted/deprecated/superseded)
|
|
10
|
+
- [ ] `date` 字段记录决策日期
|
|
11
|
+
|
|
12
|
+
## 决策质量
|
|
13
|
+
|
|
14
|
+
- [ ] 背景清晰描述问题域
|
|
15
|
+
- [ ] 至少考虑 2 个选项
|
|
16
|
+
- [ ] 每个选项有优缺点分析
|
|
17
|
+
- [ ] 决策理由与驱动因素一致
|
|
18
|
+
|
|
19
|
+
## 追溯性
|
|
20
|
+
|
|
21
|
+
- [ ] 关联相关功能特性或设计文档
|
|
22
|
+
- [ ] 决策影响范围已识别
|
|
23
|
+
- [ ] 相关方已通知或参与
|
|
24
|
+
|
|
25
|
+
## 可验证性
|
|
26
|
+
|
|
27
|
+
- [ ] 影响分析包含正面和负面
|
|
28
|
+
- [ ] 验证方法可执行
|
|
29
|
+
- [ ] 决策可追溯到实际实现
|
|
30
|
+
|
|
31
|
+
## 生命周期
|
|
32
|
+
|
|
33
|
+
- [ ] proposed 状态应有决策期限
|
|
34
|
+
- [ ] accepted 状态应有实现计划
|
|
35
|
+
- [ ] deprecated/superseded 应记录替代决策 ID
|
|
@@ -0,0 +1,66 @@
|
|
|
1
|
+
---
|
|
2
|
+
id: {DECISION_ID}
|
|
3
|
+
title: {标题}
|
|
4
|
+
status: proposed
|
|
5
|
+
date: {YYYY-MM-DD}
|
|
6
|
+
decision_makers: []
|
|
7
|
+
related_features: []
|
|
8
|
+
---
|
|
9
|
+
|
|
10
|
+
# {DECISION_ID}: {标题}
|
|
11
|
+
|
|
12
|
+
<!-- 本模板是插件 starter 指导,项目本地模板可完全覆盖 -->
|
|
13
|
+
|
|
14
|
+
## 背景
|
|
15
|
+
|
|
16
|
+
{描述需要做出决策的背景、问题或机遇}
|
|
17
|
+
|
|
18
|
+
## 决策驱动因素
|
|
19
|
+
|
|
20
|
+
{列出影响决策的关键因素}
|
|
21
|
+
|
|
22
|
+
1. {驱动因素 1}
|
|
23
|
+
2. {驱动因素 2}
|
|
24
|
+
3. {驱动因素 3}
|
|
25
|
+
|
|
26
|
+
## 考虑的选项
|
|
27
|
+
|
|
28
|
+
### 选项 1:{选项名称}
|
|
29
|
+
|
|
30
|
+
**描述**:{选项描述}
|
|
31
|
+
|
|
32
|
+
**优点**:
|
|
33
|
+
- {优点 1}
|
|
34
|
+
- {优点 2}
|
|
35
|
+
|
|
36
|
+
**缺点**:
|
|
37
|
+
- {缺点 1}
|
|
38
|
+
- {缺点 2}
|
|
39
|
+
|
|
40
|
+
### 选项 2:{选项名称}
|
|
41
|
+
|
|
42
|
+
**描述**:{选项描述}
|
|
43
|
+
|
|
44
|
+
**优点**:
|
|
45
|
+
- {优点 1}
|
|
46
|
+
|
|
47
|
+
**缺点**:
|
|
48
|
+
- {缺点 1}
|
|
49
|
+
|
|
50
|
+
## 决策
|
|
51
|
+
|
|
52
|
+
{选择的选项及理由}
|
|
53
|
+
|
|
54
|
+
## 影响
|
|
55
|
+
|
|
56
|
+
{决策带来的正面和负面影响}
|
|
57
|
+
|
|
58
|
+
## 验证
|
|
59
|
+
|
|
60
|
+
{如何验证这个决策是否正确}
|
|
61
|
+
|
|
62
|
+
## 变更日志
|
|
63
|
+
|
|
64
|
+
| 日期 | 状态变更 | 原因 |
|
|
65
|
+
|------|---------|------|
|
|
66
|
+
| {YYYY-MM-DD} | proposed | 初始提议 |
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
# Design 审查清单
|
|
2
|
+
|
|
3
|
+
<!-- 本清单是插件通用基线,项目本地审查规则可覆盖 -->
|
|
4
|
+
|
|
5
|
+
## 结构完整性
|
|
6
|
+
|
|
7
|
+
- [ ] 标题清晰表达设计范围
|
|
8
|
+
- [ ] 概述包含目标、范围和约束
|
|
9
|
+
- [ ] 至少包含架构视图和详细设计
|
|
10
|
+
- [ ] 关联制品字段完整
|
|
11
|
+
|
|
12
|
+
## 设计质量
|
|
13
|
+
|
|
14
|
+
- [ ] 设计目标具体可验证
|
|
15
|
+
- [ ] 组件职责单一明确
|
|
16
|
+
- [ ] 接口定义完整(输入/输出/错误)
|
|
17
|
+
- [ ] 数据流清晰可追溯
|
|
18
|
+
|
|
19
|
+
## 非功能需求
|
|
20
|
+
|
|
21
|
+
- [ ] 性能要求已识别
|
|
22
|
+
- [ ] 安全考虑已记录
|
|
23
|
+
- [ ] 可扩展性已设计
|
|
24
|
+
|
|
25
|
+
## 风险管理
|
|
26
|
+
|
|
27
|
+
- [ ] 风险已识别和评估
|
|
28
|
+
- [ ] 缓解措施具体可行
|
|
29
|
+
- [ ] 风险负责人已指定
|
|
30
|
+
|
|
31
|
+
## 追溯性
|
|
32
|
+
|
|
33
|
+
- [ ] 关联功能特性存在
|
|
34
|
+
- [ ] 关联决策已做出
|
|
35
|
+
- [ ] 设计可追溯到需求
|
|
36
|
+
|
|
37
|
+
## 可实现性
|
|
38
|
+
|
|
39
|
+
- [ ] 设计可在当前技术栈实现
|
|
40
|
+
- [ ] 工作量估算合理
|
|
41
|
+
- [ ] 依赖项已识别
|
|
@@ -0,0 +1,84 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: {设计文档标题}
|
|
3
|
+
related_features: []
|
|
4
|
+
related_decisions: []
|
|
5
|
+
related_scenarios: []
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
# {设计文档标题}
|
|
9
|
+
|
|
10
|
+
<!-- 本模板是插件 starter 指导,项目本地模板可完全覆盖 -->
|
|
11
|
+
|
|
12
|
+
## 概述
|
|
13
|
+
|
|
14
|
+
{用一段话描述设计目标、范围和主要约束}
|
|
15
|
+
|
|
16
|
+
## 设计目标
|
|
17
|
+
|
|
18
|
+
1. {设计目标 1}
|
|
19
|
+
2. {设计目标 2}
|
|
20
|
+
3. {设计目标 3}
|
|
21
|
+
|
|
22
|
+
## 架构视图
|
|
23
|
+
|
|
24
|
+
### 组件图
|
|
25
|
+
|
|
26
|
+
{描述主要组件及其关系}
|
|
27
|
+
|
|
28
|
+
### 数据流
|
|
29
|
+
|
|
30
|
+
{描述关键数据流或处理流程}
|
|
31
|
+
|
|
32
|
+
### 接口设计
|
|
33
|
+
|
|
34
|
+
{列出主要接口及其契约}
|
|
35
|
+
|
|
36
|
+
## 详细设计
|
|
37
|
+
|
|
38
|
+
### 模块 1:{模块名称}
|
|
39
|
+
|
|
40
|
+
**职责**:{模块职责}
|
|
41
|
+
|
|
42
|
+
**接口**:
|
|
43
|
+
- {接口 1}
|
|
44
|
+
- {接口 2}
|
|
45
|
+
|
|
46
|
+
**实现要点**:
|
|
47
|
+
- {实现要点 1}
|
|
48
|
+
- {实现要点 2}
|
|
49
|
+
|
|
50
|
+
### 模块 2:{模块名称}
|
|
51
|
+
|
|
52
|
+
{同上结构}
|
|
53
|
+
|
|
54
|
+
## 非功能需求
|
|
55
|
+
|
|
56
|
+
### 性能
|
|
57
|
+
|
|
58
|
+
{性能要求和约束}
|
|
59
|
+
|
|
60
|
+
### 安全
|
|
61
|
+
|
|
62
|
+
{安全考虑}
|
|
63
|
+
|
|
64
|
+
### 可扩展性
|
|
65
|
+
|
|
66
|
+
{可扩展性设计}
|
|
67
|
+
|
|
68
|
+
## 风险与缓解
|
|
69
|
+
|
|
70
|
+
| 风险 | 影响 | 概率 | 缓解措施 |
|
|
71
|
+
|------|------|------|---------|
|
|
72
|
+
| {风险 1} | {影响} | {概率} | {措施} |
|
|
73
|
+
|
|
74
|
+
## 关联制品
|
|
75
|
+
|
|
76
|
+
- 功能特性:{related_features}
|
|
77
|
+
- 决策:{related_decisions}
|
|
78
|
+
- 场景:{related_scenarios}
|
|
79
|
+
|
|
80
|
+
## 变更日志
|
|
81
|
+
|
|
82
|
+
| 日期 | 变更 | 作者 |
|
|
83
|
+
|------|------|------|
|
|
84
|
+
| {YYYY-MM-DD} | 初始草稿 | {作者} |
|
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
# E2E Test 审查清单
|
|
2
|
+
|
|
3
|
+
<!-- 本清单是插件通用基线,项目本地审查规则可覆盖 -->
|
|
4
|
+
|
|
5
|
+
## 结构完整性
|
|
6
|
+
|
|
7
|
+
- [ ] `id` 字段存在且符合项目 ID 模式
|
|
8
|
+
- [ ] `title` 清晰描述测试的端到端流程
|
|
9
|
+
- [ ] `status` 字段存在且为有效值
|
|
10
|
+
- [ ] 测试场景覆盖主流程
|
|
11
|
+
|
|
12
|
+
## 测试质量
|
|
13
|
+
|
|
14
|
+
- [ ] 前置条件具体可准备
|
|
15
|
+
- [ ] 测试步骤可执行
|
|
16
|
+
- [ ] 预期结果可验证
|
|
17
|
+
- [ ] 覆盖关键用户流程
|
|
18
|
+
|
|
19
|
+
## 覆盖范围
|
|
20
|
+
|
|
21
|
+
- [ ] 主场景完整覆盖
|
|
22
|
+
- [ ] 关键备选场景已覆盖
|
|
23
|
+
- [ ] 错误路径已测试
|
|
24
|
+
- [ ] 边界条件已考虑
|
|
25
|
+
|
|
26
|
+
## 追溯性
|
|
27
|
+
|
|
28
|
+
- [ ] 关联功能特性存在
|
|
29
|
+
- [ ] 关联场景存在
|
|
30
|
+
- [ ] 测试可追溯到用户需求
|
|
31
|
+
|
|
32
|
+
## 可执行性
|
|
33
|
+
|
|
34
|
+
- [ ] 测试环境要求明确
|
|
35
|
+
- [ ] 测试数据可准备
|
|
36
|
+
- [ ] 测试可自动化或手动执行
|
|
37
|
+
- [ ] 测试结果可重现
|
|
38
|
+
|
|
39
|
+
## 维护性
|
|
40
|
+
|
|
41
|
+
- [ ] 测试易于理解
|
|
42
|
+
- [ ] 测试数据与实现解耦
|
|
43
|
+
- [ ] 测试可适应 UI/API 变更
|
|
@@ -0,0 +1,70 @@
|
|
|
1
|
+
---
|
|
2
|
+
id: {E2E_TEST_ID}
|
|
3
|
+
title: {标题}
|
|
4
|
+
status: draft
|
|
5
|
+
related_features: []
|
|
6
|
+
related_scenarios: []
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
# {E2E_TEST_ID}: {标题}
|
|
10
|
+
|
|
11
|
+
<!-- 本模板是插件 starter 指导,项目本地模板可完全覆盖 -->
|
|
12
|
+
|
|
13
|
+
## 测试目标
|
|
14
|
+
|
|
15
|
+
{描述这个端到端测试要验证的完整用户流程}
|
|
16
|
+
|
|
17
|
+
## 测试场景
|
|
18
|
+
|
|
19
|
+
### 主场景:{场景名称}
|
|
20
|
+
|
|
21
|
+
**前置条件**:
|
|
22
|
+
- {条件 1}
|
|
23
|
+
- {条件 2}
|
|
24
|
+
|
|
25
|
+
**测试步骤**:
|
|
26
|
+
1. {步骤 1}
|
|
27
|
+
2. {步骤 2}
|
|
28
|
+
3. {步骤 3}
|
|
29
|
+
|
|
30
|
+
**预期结果**:
|
|
31
|
+
- {结果 1}
|
|
32
|
+
- {结果 2}
|
|
33
|
+
|
|
34
|
+
### 备选场景:{场景名称}
|
|
35
|
+
|
|
36
|
+
{同上结构}
|
|
37
|
+
|
|
38
|
+
## 测试数据
|
|
39
|
+
|
|
40
|
+
{描述测试所需的数据准备}
|
|
41
|
+
|
|
42
|
+
## 环境要求
|
|
43
|
+
|
|
44
|
+
{列出测试环境的特殊要求}
|
|
45
|
+
|
|
46
|
+
## 自动化脚本
|
|
47
|
+
|
|
48
|
+
{如果适用,关联自动化测试脚本路径}
|
|
49
|
+
|
|
50
|
+
```typescript
|
|
51
|
+
// 示例:Playwright E2E 测试
|
|
52
|
+
import { test, expect } from '@playwright/test';
|
|
53
|
+
|
|
54
|
+
test('{测试名称}', async ({ page }) => {
|
|
55
|
+
await page.goto('{URL}');
|
|
56
|
+
await page.click('{选择器}');
|
|
57
|
+
await expect(page.locator('{选择器}')).toHaveText('{预期文本}');
|
|
58
|
+
});
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
## 关联制品
|
|
62
|
+
|
|
63
|
+
- 功能特性:{related_features}
|
|
64
|
+
- 场景:{related_scenarios}
|
|
65
|
+
|
|
66
|
+
## 变更日志
|
|
67
|
+
|
|
68
|
+
| 日期 | 变更 | 作者 |
|
|
69
|
+
|------|------|------|
|
|
70
|
+
| {YYYY-MM-DD} | 初始草稿 | {作者} |
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
# Feature 审查清单
|
|
2
|
+
|
|
3
|
+
<!-- 本清单是插件通用基线,项目本地审查规则可覆盖 -->
|
|
4
|
+
|
|
5
|
+
## 结构完整性
|
|
6
|
+
|
|
7
|
+
- [ ] `id` 字段存在且符合项目 ID 模式(如 `ACA{nn}`)
|
|
8
|
+
- [ ] `title` 字段存在且简洁明确
|
|
9
|
+
- [ ] `status` 字段存在且为有效值(draft/active/done/deprecated)
|
|
10
|
+
- [ ] 验收标准至少 3 条,每条可独立验证
|
|
11
|
+
|
|
12
|
+
## 内容质量
|
|
13
|
+
|
|
14
|
+
- [ ] 概述清晰描述问题域和解决目标
|
|
15
|
+
- [ ] 验收标准使用可测试的表述(避免"应该"、"可能")
|
|
16
|
+
- [ ] 关联的场景 ID 存在且有效
|
|
17
|
+
- [ ] 设计约束已识别并记录
|
|
18
|
+
|
|
19
|
+
## 追溯性
|
|
20
|
+
|
|
21
|
+
- [ ] 至少关联一个场景或设计文档
|
|
22
|
+
- [ ] 关联的制品 ID 在图中可查
|
|
23
|
+
- [ ] 验收标准可追溯到场景测试
|
|
24
|
+
|
|
25
|
+
## 生命周期
|
|
26
|
+
|
|
27
|
+
- [ ] 草稿状态的 feature 可以缺少部分关联
|
|
28
|
+
- [ ] active 状态的 feature 必须有完整关联
|
|
29
|
+
- [ ] done/deprecated 状态的 feature 应记录完成原因
|
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
---
|
|
2
|
+
id: {FEATURE_ID}
|
|
3
|
+
title: {标题}
|
|
4
|
+
status: draft
|
|
5
|
+
scenarios: []
|
|
6
|
+
design_docs: []
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
# {FEATURE_ID}: {标题}
|
|
10
|
+
|
|
11
|
+
<!-- 本模板是插件 starter 指导,项目本地模板可完全覆盖 -->
|
|
12
|
+
|
|
13
|
+
## 概述
|
|
14
|
+
|
|
15
|
+
{用一两句话描述这个功能特性要解决的核心问题}
|
|
16
|
+
|
|
17
|
+
## 验收标准
|
|
18
|
+
|
|
19
|
+
{列出可验证的验收标准,每条标准应可独立测试}
|
|
20
|
+
|
|
21
|
+
1. {验收标准 1}
|
|
22
|
+
2. {验收标准 2}
|
|
23
|
+
3. {验收标准 3}
|
|
24
|
+
|
|
25
|
+
## 用户场景
|
|
26
|
+
|
|
27
|
+
{关联的场景 ID,或在此描述主要用户场景}
|
|
28
|
+
|
|
29
|
+
## 设计约束
|
|
30
|
+
|
|
31
|
+
{列出已知的技术、业务或时间约束}
|
|
32
|
+
|
|
33
|
+
## 关联制品
|
|
34
|
+
|
|
35
|
+
- 设计文档:{design_docs}
|
|
36
|
+
- 场景:{scenarios}
|
|
37
|
+
- 决策:{related_decisions}
|
|
38
|
+
|
|
39
|
+
## 变更日志
|
|
40
|
+
|
|
41
|
+
| 日期 | 变更 | 作者 |
|
|
42
|
+
|------|------|------|
|
|
43
|
+
| {YYYY-MM-DD} | 初始草稿 | {作者} |
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
# Scenario 审查清单
|
|
2
|
+
|
|
3
|
+
<!-- 本清单是插件通用基线,项目本地审查规则可覆盖 -->
|
|
4
|
+
|
|
5
|
+
## 结构完整性
|
|
6
|
+
|
|
7
|
+
- [ ] `id` 字段存在且符合项目 ID 模式(如 `S-{nn}`)
|
|
8
|
+
- [ ] `title` 字段存在且描述场景本质
|
|
9
|
+
- [ ] `status` 字段存在且为有效值
|
|
10
|
+
- [ ] 角色与目标清晰定义
|
|
11
|
+
|
|
12
|
+
## 流程质量
|
|
13
|
+
|
|
14
|
+
- [ ] 主流程使用 Given/When/Then 格式
|
|
15
|
+
- [ ] 至少覆盖一个备选流程
|
|
16
|
+
- [ ] 前置条件可验证
|
|
17
|
+
- [ ] 系统响应具体可测试
|
|
18
|
+
|
|
19
|
+
## 追溯性
|
|
20
|
+
|
|
21
|
+
- [ ] 关联至少一个功能特性
|
|
22
|
+
- [ ] 关联的功能特性 ID 存在
|
|
23
|
+
- [ ] 场景可追溯到功能需求
|
|
24
|
+
|
|
25
|
+
## 可执行性
|
|
26
|
+
|
|
27
|
+
- [ ] 场景可以手动或自动执行
|
|
28
|
+
- [ ] 验收标准与流程步骤一致
|
|
29
|
+
- [ ] 备选流程覆盖关键异常路径
|
|
@@ -0,0 +1,57 @@
|
|
|
1
|
+
---
|
|
2
|
+
id: {SCENARIO_ID}
|
|
3
|
+
title: {标题}
|
|
4
|
+
status: draft
|
|
5
|
+
related_features: []
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
# {SCENARIO_ID}: {标题}
|
|
9
|
+
|
|
10
|
+
<!-- 本模板是插件 starter 指导,项目本地模板可完全覆盖 -->
|
|
11
|
+
|
|
12
|
+
## 角色与目标
|
|
13
|
+
|
|
14
|
+
**角色**:{用户角色}
|
|
15
|
+
**目标**:{用户要完成的任务}
|
|
16
|
+
|
|
17
|
+
## 前置条件
|
|
18
|
+
|
|
19
|
+
{列出执行此场景前必须满足的条件}
|
|
20
|
+
|
|
21
|
+
## 主流程
|
|
22
|
+
|
|
23
|
+
```gherkin
|
|
24
|
+
Given {前置状态}
|
|
25
|
+
When {用户操作}
|
|
26
|
+
Then {系统响应}
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
## 备选流程
|
|
30
|
+
|
|
31
|
+
### 备选 1:{备选流程名称}
|
|
32
|
+
|
|
33
|
+
```gherkin
|
|
34
|
+
Given {前置状态}
|
|
35
|
+
When {异常操作}
|
|
36
|
+
Then {错误处理或备选路径}
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
## 验收标准
|
|
40
|
+
|
|
41
|
+
1. {场景验收标准 1}
|
|
42
|
+
2. {场景验收标准 2}
|
|
43
|
+
|
|
44
|
+
## 关联制品
|
|
45
|
+
|
|
46
|
+
- 功能特性:{related_features}
|
|
47
|
+
- 设计文档:{related_designs}
|
|
48
|
+
|
|
49
|
+
## 测试脚本
|
|
50
|
+
|
|
51
|
+
{如果适用,关联自动化测试脚本路径}
|
|
52
|
+
|
|
53
|
+
## 变更日志
|
|
54
|
+
|
|
55
|
+
| 日期 | 变更 | 作者 |
|
|
56
|
+
|------|------|------|
|
|
57
|
+
| {YYYY-MM-DD} | 初始草稿 | {作者} |
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
# Test 审查清单
|
|
2
|
+
|
|
3
|
+
<!-- 本清单是插件通用基线,项目本地审查规则可覆盖 -->
|
|
4
|
+
|
|
5
|
+
## 测试结构
|
|
6
|
+
|
|
7
|
+
- [ ] 测试文件组织清晰(按模块或功能)
|
|
8
|
+
- [ ] 测试命名描述预期行为
|
|
9
|
+
- [ ] 使用 Arrange-Act-Assert 或 Given-When-Then 模式
|
|
10
|
+
- [ ] 测试独立,不依赖执行顺序
|
|
11
|
+
|
|
12
|
+
## 覆盖质量
|
|
13
|
+
|
|
14
|
+
- [ ] 正常路径已覆盖
|
|
15
|
+
- [ ] 边界条件已测试
|
|
16
|
+
- [ ] 异常路径已覆盖
|
|
17
|
+
- [ ] 关键业务逻辑测试充分
|
|
18
|
+
|
|
19
|
+
## 代码质量
|
|
20
|
+
|
|
21
|
+
- [ ] 测试代码可读性好
|
|
22
|
+
- [ ] 避免测试实现细节
|
|
23
|
+
- [ ] Mock 使用合理,不过度 mock
|
|
24
|
+
- [ ] 断言明确具体
|
|
25
|
+
|
|
26
|
+
## 追溯性
|
|
27
|
+
|
|
28
|
+
- [ ] 测试关联功能特性(通过追溯注释)
|
|
29
|
+
- [ ] 测试覆盖验收标准
|
|
30
|
+
- [ ] 测试可追溯到需求
|
|
31
|
+
|
|
32
|
+
## 可维护性
|
|
33
|
+
|
|
34
|
+
- [ ] 测试易于理解和修改
|
|
35
|
+
- [ ] 测试数据构造清晰
|
|
36
|
+
- [ ] 测试环境隔离
|
|
37
|
+
- [ ] 测试执行稳定(无随机失败)
|