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,78 @@
|
|
|
1
|
+
# IPC Contract 审查清单
|
|
2
|
+
|
|
3
|
+
<!-- 本清单是插件通用基线,项目本地审查规则可覆盖 -->
|
|
4
|
+
|
|
5
|
+
## 结构完整性
|
|
6
|
+
|
|
7
|
+
- [ ] `id` 字段存在且符合项目 ID 模式(如 `IPC-{nnn}`)
|
|
8
|
+
- [ ] `title` 清晰描述 IPC 通道范围
|
|
9
|
+
- [ ] `version` 字段存在且符合语义化版本
|
|
10
|
+
- [ ] `status` 字段存在且为有效值
|
|
11
|
+
|
|
12
|
+
## 消息定义
|
|
13
|
+
|
|
14
|
+
- [ ] 请求消息结构完整
|
|
15
|
+
- [ ] 响应消息结构完整
|
|
16
|
+
- [ ] 事件消息定义清晰(如适用)
|
|
17
|
+
- [ ] 消息类型定义使用 TypeScript 接口
|
|
18
|
+
|
|
19
|
+
## 通道规范
|
|
20
|
+
|
|
21
|
+
- [ ] 通道名称明确
|
|
22
|
+
- [ ] 通信方向清晰(前端→后端/后端→前端/双向)
|
|
23
|
+
- [ ] 请求和响应示例完整
|
|
24
|
+
- [ ] 错误码覆盖常见异常场景
|
|
25
|
+
|
|
26
|
+
## 序列化规范
|
|
27
|
+
|
|
28
|
+
- [ ] 数据格式明确(JSON/MessagePack/Protobuf)
|
|
29
|
+
- [ ] 类型映射表完整
|
|
30
|
+
- [ ] 日期和数字精度有说明
|
|
31
|
+
- [ ] 字符编码有说明
|
|
32
|
+
|
|
33
|
+
## 边界规则
|
|
34
|
+
|
|
35
|
+
- [ ] 前端职责范围明确
|
|
36
|
+
- [ ] 后端职责范围明确
|
|
37
|
+
- [ ] 禁止事项有明确说明
|
|
38
|
+
- [ ] 前后端边界清晰无歧义
|
|
39
|
+
|
|
40
|
+
## 错误处理
|
|
41
|
+
|
|
42
|
+
- [ ] 错误码定义完整
|
|
43
|
+
- [ ] 错误消息用户友好
|
|
44
|
+
- [ ] 错误恢复方式明确
|
|
45
|
+
- [ ] 不暴露内部实现细节
|
|
46
|
+
|
|
47
|
+
## 性能要求
|
|
48
|
+
|
|
49
|
+
- [ ] 延迟指标有明确目标
|
|
50
|
+
- [ ] 大数据传输策略有说明
|
|
51
|
+
- [ ] 并发限制有说明
|
|
52
|
+
- [ ] 超时设置有说明
|
|
53
|
+
|
|
54
|
+
## 安全性
|
|
55
|
+
|
|
56
|
+
- [ ] 输入验证规则完整
|
|
57
|
+
- [ ] 权限控制机制明确
|
|
58
|
+
- [ ] 敏感信息处理有说明
|
|
59
|
+
- [ ] 防攻击措施有说明
|
|
60
|
+
|
|
61
|
+
## 版本兼容
|
|
62
|
+
|
|
63
|
+
- [ ] 向后兼容规则明确
|
|
64
|
+
- [ ] 破坏性变更有处理流程
|
|
65
|
+
- [ ] 版本迁移有说明
|
|
66
|
+
- [ ] 旧版本兼容期有定义
|
|
67
|
+
|
|
68
|
+
## 追溯性
|
|
69
|
+
|
|
70
|
+
- [ ] 关联功能特性存在
|
|
71
|
+
- [ ] IPC 通道可追溯到业务需求
|
|
72
|
+
- [ ] 与 UI 契约关联清晰
|
|
73
|
+
|
|
74
|
+
## 实现一致性
|
|
75
|
+
|
|
76
|
+
- [ ] 与实际实现代码一致
|
|
77
|
+
- [ ] 文档与实际行为匹配
|
|
78
|
+
- [ ] 类型定义与代码类型一致
|
|
@@ -0,0 +1,214 @@
|
|
|
1
|
+
---
|
|
2
|
+
id: {IPC_ID}
|
|
3
|
+
title: {IPC 通道名称}
|
|
4
|
+
status: draft
|
|
5
|
+
version: {v1}
|
|
6
|
+
related_features: []
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
# {IPC_ID}: {IPC 通道名称}
|
|
10
|
+
|
|
11
|
+
<!-- 本模板是插件 starter 指导,项目本地模板可完全覆盖 -->
|
|
12
|
+
<!-- 插件模板是入门指导,项目本地模板是权威 -->
|
|
13
|
+
|
|
14
|
+
## 概述
|
|
15
|
+
|
|
16
|
+
{描述这个 IPC 通道的用途、通信方向和主要能力}
|
|
17
|
+
|
|
18
|
+
## 基础信息
|
|
19
|
+
|
|
20
|
+
- **版本**:{version}
|
|
21
|
+
- **通信方向**:Frontend → Backend / Backend → Frontend / 双向
|
|
22
|
+
- **通道名称**:{channel_name}
|
|
23
|
+
- **框架**:Tauri / Electron / 自定义
|
|
24
|
+
|
|
25
|
+
## 消息定义
|
|
26
|
+
|
|
27
|
+
### 请求消息
|
|
28
|
+
|
|
29
|
+
```typescript
|
|
30
|
+
interface {RequestName} {
|
|
31
|
+
// 请求标识
|
|
32
|
+
id: string;
|
|
33
|
+
// 请求类型
|
|
34
|
+
type: "{request_type}";
|
|
35
|
+
// 请求载荷
|
|
36
|
+
payload: {
|
|
37
|
+
field1: string;
|
|
38
|
+
field2: number;
|
|
39
|
+
field3?: boolean; // 可选字段
|
|
40
|
+
};
|
|
41
|
+
}
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
### 响应消息
|
|
45
|
+
|
|
46
|
+
```typescript
|
|
47
|
+
interface {ResponseName} {
|
|
48
|
+
// 对应请求 ID
|
|
49
|
+
requestId: string;
|
|
50
|
+
// 响应状态
|
|
51
|
+
status: "success" | "error";
|
|
52
|
+
// 成功时的数据
|
|
53
|
+
data?: {
|
|
54
|
+
result: string;
|
|
55
|
+
metadata?: Record<string, unknown>;
|
|
56
|
+
};
|
|
57
|
+
// 错误时的信息
|
|
58
|
+
error?: {
|
|
59
|
+
code: string;
|
|
60
|
+
message: string;
|
|
61
|
+
details?: unknown;
|
|
62
|
+
};
|
|
63
|
+
}
|
|
64
|
+
```
|
|
65
|
+
|
|
66
|
+
### 事件消息(后端主动推送)
|
|
67
|
+
|
|
68
|
+
```typescript
|
|
69
|
+
interface {EventName} {
|
|
70
|
+
// 事件类型
|
|
71
|
+
type: "{event_type}";
|
|
72
|
+
// 事件载荷
|
|
73
|
+
payload: {
|
|
74
|
+
timestamp: number;
|
|
75
|
+
data: unknown;
|
|
76
|
+
};
|
|
77
|
+
}
|
|
78
|
+
```
|
|
79
|
+
|
|
80
|
+
## 通道列表
|
|
81
|
+
|
|
82
|
+
### {channel_name}
|
|
83
|
+
|
|
84
|
+
**描述**:{通道描述}
|
|
85
|
+
|
|
86
|
+
**方向**:{Frontend → Backend / Backend → Frontend / 双向}
|
|
87
|
+
|
|
88
|
+
**请求示例**:
|
|
89
|
+
|
|
90
|
+
```typescript
|
|
91
|
+
// 前端发送
|
|
92
|
+
invoke("{channel_name}", {
|
|
93
|
+
param1: "value",
|
|
94
|
+
param2: 123
|
|
95
|
+
});
|
|
96
|
+
|
|
97
|
+
// 后端响应
|
|
98
|
+
{
|
|
99
|
+
requestId: "req_123",
|
|
100
|
+
status: "success",
|
|
101
|
+
data: { result: "processed" }
|
|
102
|
+
}
|
|
103
|
+
```
|
|
104
|
+
|
|
105
|
+
**错误处理**:
|
|
106
|
+
|
|
107
|
+
| 错误码 | 描述 | 前端处理 |
|
|
108
|
+
|--------|------|---------|
|
|
109
|
+
| INVALID_PARAM | 参数无效 | 提示用户修正输入 |
|
|
110
|
+
| TIMEOUT | 请求超时 | 重试或提示稍后 |
|
|
111
|
+
| PERMISSION_DENIED | 权限不足 | 提示用户授权 |
|
|
112
|
+
| INTERNAL_ERROR | 内部错误 | 记录日志,提示联系支持 |
|
|
113
|
+
|
|
114
|
+
## 序列化规范
|
|
115
|
+
|
|
116
|
+
### 数据格式
|
|
117
|
+
|
|
118
|
+
- **编码**:JSON / MessagePack / Protobuf
|
|
119
|
+
- **字符编码**:UTF-8
|
|
120
|
+
- **日期格式**:ISO 8601 或 Unix 时间戳
|
|
121
|
+
- **数字精度**:整数 i64,浮点 f64
|
|
122
|
+
|
|
123
|
+
### 类型映射
|
|
124
|
+
|
|
125
|
+
| TypeScript | Rust/后端 | 说明 |
|
|
126
|
+
|-----------|----------|------|
|
|
127
|
+
| string | String | UTF-8 字符串 |
|
|
128
|
+
| number | i64 / f64 | 整数或浮点 |
|
|
129
|
+
| boolean | bool | 布尔值 |
|
|
130
|
+
| Array<T> | Vec<T> | 数组 |
|
|
131
|
+
| object | Struct | 对象 |
|
|
132
|
+
| null | Option::None | 可选值 |
|
|
133
|
+
|
|
134
|
+
## 边界规则
|
|
135
|
+
|
|
136
|
+
### 前端职责
|
|
137
|
+
|
|
138
|
+
- UI 状态管理
|
|
139
|
+
- 用户输入验证
|
|
140
|
+
- 错误展示
|
|
141
|
+
- 加载状态
|
|
142
|
+
|
|
143
|
+
### 后端职责
|
|
144
|
+
|
|
145
|
+
- 业务逻辑处理
|
|
146
|
+
- 数据持久化
|
|
147
|
+
- 文件系统访问
|
|
148
|
+
- 系统 API 调用
|
|
149
|
+
- 安全验证
|
|
150
|
+
|
|
151
|
+
### 禁止事项
|
|
152
|
+
|
|
153
|
+
- ❌ 前端直接访问文件系统
|
|
154
|
+
- ❌ 前端存储敏感信息(密码、Token 明文)
|
|
155
|
+
- ❌ 后端直接操作 DOM
|
|
156
|
+
- ❌ 绕过 IPC 通道的通信
|
|
157
|
+
|
|
158
|
+
## 性能要求
|
|
159
|
+
|
|
160
|
+
| 指标 | 目标值 | 说明 |
|
|
161
|
+
|------|-------|------|
|
|
162
|
+
| 单次调用延迟 | < {X} ms | 本地调用 |
|
|
163
|
+
| 大数据传输 | 分片传输 | 超过 1MB 的数据 |
|
|
164
|
+
| 并发调用 | 限制 {N} 个 | 防止资源耗尽 |
|
|
165
|
+
| 超时时间 | {X} 秒 | 默认超时 |
|
|
166
|
+
|
|
167
|
+
## 安全考虑
|
|
168
|
+
|
|
169
|
+
### 输入验证
|
|
170
|
+
|
|
171
|
+
- [ ] 所有输入参数在后端验证
|
|
172
|
+
- [ ] 防止路径遍历攻击
|
|
173
|
+
- [ ] 防止注入攻击
|
|
174
|
+
- [ ] 限制输入长度和大小
|
|
175
|
+
|
|
176
|
+
### 权限控制
|
|
177
|
+
|
|
178
|
+
- [ ] 敏感操作需要权限确认
|
|
179
|
+
- [ ] 最小权限原则
|
|
180
|
+
- [ ] 权限检查在后端执行
|
|
181
|
+
|
|
182
|
+
### 错误信息
|
|
183
|
+
|
|
184
|
+
- [ ] 不暴露内部实现细节
|
|
185
|
+
- [ ] 错误码和消息分离
|
|
186
|
+
- [ ] 敏感信息不记录日志
|
|
187
|
+
|
|
188
|
+
## 版本兼容
|
|
189
|
+
|
|
190
|
+
### 向后兼容规则
|
|
191
|
+
|
|
192
|
+
- 新增字段使用可选类型
|
|
193
|
+
- 不删除已有字段
|
|
194
|
+
- 不改变字段类型
|
|
195
|
+
- 新增通道不影响已有通道
|
|
196
|
+
|
|
197
|
+
### 破坏性变更处理
|
|
198
|
+
|
|
199
|
+
- 版本号递增
|
|
200
|
+
- 迁移指南文档
|
|
201
|
+
- 旧版本兼容期
|
|
202
|
+
- 客户端升级提示
|
|
203
|
+
|
|
204
|
+
## 关联制品
|
|
205
|
+
|
|
206
|
+
- 功能特性:{related_features}
|
|
207
|
+
- 设计文档:{related_designs}
|
|
208
|
+
- UI 契约:{related_ui_contracts}
|
|
209
|
+
|
|
210
|
+
## 变更日志
|
|
211
|
+
|
|
212
|
+
| 日期 | 版本 | 变更 | 作者 |
|
|
213
|
+
|------|------|------|------|
|
|
214
|
+
| {YYYY-MM-DD} | v1 | 初始版本 | {作者} |
|
|
@@ -0,0 +1,61 @@
|
|
|
1
|
+
# Report Contract 审查清单
|
|
2
|
+
|
|
3
|
+
<!-- 本清单是插件通用基线,项目本地审查规则可覆盖 -->
|
|
4
|
+
|
|
5
|
+
## 结构完整性
|
|
6
|
+
|
|
7
|
+
- [ ] `id` 字段存在且符合项目 ID 模式(如 `RPT-{nnn}`)
|
|
8
|
+
- [ ] `title` 清晰描述报告范围
|
|
9
|
+
- [ ] `version` 字段存在且符合语义化版本
|
|
10
|
+
- [ ] `status` 字段存在且为有效值
|
|
11
|
+
- [ ] `output_format` 字段存在且为有效格式
|
|
12
|
+
|
|
13
|
+
## 数据源质量
|
|
14
|
+
|
|
15
|
+
- [ ] 所有数据源已列出
|
|
16
|
+
- [ ] 数据源类型明确(数据库 / API / 文件)
|
|
17
|
+
- [ ] 数据刷新频率已定义
|
|
18
|
+
- [ ] 数据源可靠性已评估
|
|
19
|
+
|
|
20
|
+
## 字段定义
|
|
21
|
+
|
|
22
|
+
- [ ] 所有字段有清晰的中文/英文名称
|
|
23
|
+
- [ ] 字段类型明确(string / number / date / boolean)
|
|
24
|
+
- [ ] 聚合逻辑已定义(SUM / AVG / COUNT / MAX / MIN / NONE)
|
|
25
|
+
- [ ] 字段含义有详细说明
|
|
26
|
+
|
|
27
|
+
## 时间窗口
|
|
28
|
+
|
|
29
|
+
- [ ] 报告周期已定义
|
|
30
|
+
- [ ] 时间粒度已明确(小时 / 天 / 周 / 月)
|
|
31
|
+
- [ ] 时区已指定
|
|
32
|
+
- [ ] 截止规则已说明
|
|
33
|
+
|
|
34
|
+
## 聚合逻辑
|
|
35
|
+
|
|
36
|
+
- [ ] 关键指标计算规则完整
|
|
37
|
+
- [ ] 过滤条件已列出
|
|
38
|
+
- [ ] 排序规则已定义
|
|
39
|
+
- [ ] 边界情况处理已说明(如空值、零值)
|
|
40
|
+
|
|
41
|
+
## 性能与安全
|
|
42
|
+
|
|
43
|
+
- [ ] 生成时间要求已定义
|
|
44
|
+
- [ ] 数据量级已评估
|
|
45
|
+
- [ ] 并发支持已说明
|
|
46
|
+
- [ ] 数据权限已定义
|
|
47
|
+
- [ ] 敏感字段已标记并说明脱敏方式
|
|
48
|
+
|
|
49
|
+
## 追溯性
|
|
50
|
+
|
|
51
|
+
- [ ] 关联功能特性存在
|
|
52
|
+
- [ ] 报告可追溯到业务需求
|
|
53
|
+
- [ ] 版本变更可追溯
|
|
54
|
+
- [ ] 关联数据契约存在
|
|
55
|
+
|
|
56
|
+
## 实现一致性
|
|
57
|
+
|
|
58
|
+
- [ ] 报告输出与定义一致
|
|
59
|
+
- [ ] 字段计算逻辑与实现匹配
|
|
60
|
+
- [ ] 性能满足要求
|
|
61
|
+
- [ ] 测试覆盖核心场景
|
|
@@ -0,0 +1,97 @@
|
|
|
1
|
+
---
|
|
2
|
+
id: {RPT_ID}
|
|
3
|
+
title: {报告名称}
|
|
4
|
+
status: draft
|
|
5
|
+
version: {v1}
|
|
6
|
+
output_format: {输出格式}
|
|
7
|
+
related_features: []
|
|
8
|
+
---
|
|
9
|
+
|
|
10
|
+
# {RPT_ID}: {报告名称}
|
|
11
|
+
|
|
12
|
+
<!-- 本模板是插件 starter 指导,项目本地模板可完全覆盖 -->
|
|
13
|
+
<!-- 插件模板是入门指导,项目本地模板是权威 -->
|
|
14
|
+
|
|
15
|
+
## 概述
|
|
16
|
+
|
|
17
|
+
{描述这个报告的用途、业务场景和主要能力}
|
|
18
|
+
|
|
19
|
+
## 基础信息
|
|
20
|
+
|
|
21
|
+
- **版本**:{version}
|
|
22
|
+
- **输出格式**:PDF / Excel / CSV / JSON / HTML
|
|
23
|
+
- **生成频率**:每日 / 每周 / 每月 / 按需
|
|
24
|
+
- **数据时效性**:实时 / T+1 / 截止到指定时间点
|
|
25
|
+
- **目标受众**:{报告的使用者,如业务分析师、管理层、运维团队}
|
|
26
|
+
|
|
27
|
+
## 报告结构
|
|
28
|
+
|
|
29
|
+
### 数据源
|
|
30
|
+
|
|
31
|
+
| 数据源 | 类型 | 刷新频率 | 说明 |
|
|
32
|
+
|--------|------|---------|------|
|
|
33
|
+
| {数据源名称} | 数据库 / API / 文件 | {频率} | {数据源描述} |
|
|
34
|
+
|
|
35
|
+
### 字段定义
|
|
36
|
+
|
|
37
|
+
| 字段名 | 类型 | 聚合逻辑 | 说明 |
|
|
38
|
+
|--------|------|---------|------|
|
|
39
|
+
| {field_name} | {type} | SUM / AVG / COUNT / MAX / MIN / NONE | {字段含义} |
|
|
40
|
+
|
|
41
|
+
### 时间窗口
|
|
42
|
+
|
|
43
|
+
- **报告周期**:{报告覆盖的时间范围,如"过去 30 天"}
|
|
44
|
+
- **时间粒度**:小时 / 天 / 周 / 月
|
|
45
|
+
- **时区**:{时区,如 UTC / Asia/Shanghai}
|
|
46
|
+
- **截止规则**:{数据截止时间点的定义,如"每日凌晨 2:00 截止"}
|
|
47
|
+
|
|
48
|
+
## 报告示例
|
|
49
|
+
|
|
50
|
+
### 示例输出
|
|
51
|
+
|
|
52
|
+
```
|
|
53
|
+
{报告输出的示例片段}
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
## 聚合逻辑
|
|
57
|
+
|
|
58
|
+
### 计算规则
|
|
59
|
+
|
|
60
|
+
{描述关键指标的计算方法,如"订单金额 = SUM(订单明细.单价 * 数量)"}
|
|
61
|
+
|
|
62
|
+
### 过滤条件
|
|
63
|
+
|
|
64
|
+
| 条件 | 字段 | 运算符 | 值 | 说明 |
|
|
65
|
+
|------|------|--------|-----|------|
|
|
66
|
+
| {条件名称} | {field} | = / != / > / < / IN / LIKE | {value} | {条件描述} |
|
|
67
|
+
|
|
68
|
+
### 排序规则
|
|
69
|
+
|
|
70
|
+
| 排序字段 | 方向 | 说明 |
|
|
71
|
+
|---------|------|------|
|
|
72
|
+
| {field} | ASC / DESC | {排序逻辑} |
|
|
73
|
+
|
|
74
|
+
## 权限与安全
|
|
75
|
+
|
|
76
|
+
- **数据权限**:{报告访问的数据范围控制}
|
|
77
|
+
- **用户权限**:{哪些角色可以访问}
|
|
78
|
+
- **敏感字段**:{是否包含敏感数据,如何脱敏}
|
|
79
|
+
|
|
80
|
+
## 性能要求
|
|
81
|
+
|
|
82
|
+
- **生成时间**:{报告生成的最大允许时间}
|
|
83
|
+
- **数据量级**:{预期数据行数}
|
|
84
|
+
- **并发支持**:{是否支持多人同时生成}
|
|
85
|
+
|
|
86
|
+
## 关联制品
|
|
87
|
+
|
|
88
|
+
- 功能特性:{related_features}
|
|
89
|
+
- 数据契约:{related_data_contracts}
|
|
90
|
+
- 设计文档:{related_designs}
|
|
91
|
+
- 决策:{related_decisions}
|
|
92
|
+
|
|
93
|
+
## 变更日志
|
|
94
|
+
|
|
95
|
+
| 日期 | 版本 | 变更 | 作者 |
|
|
96
|
+
|------|------|------|------|
|
|
97
|
+
| {YYYY-MM-DD} | v1 | 初始版本 | {作者} |
|
|
@@ -0,0 +1,70 @@
|
|
|
1
|
+
# UI Contract 审查清单
|
|
2
|
+
|
|
3
|
+
<!-- 本清单是插件通用基线,项目本地审查规则可覆盖 -->
|
|
4
|
+
|
|
5
|
+
## 结构完整性
|
|
6
|
+
|
|
7
|
+
- [ ] `id` 字段存在且符合项目 ID 模式(如 `UI-{nnn}`)
|
|
8
|
+
- [ ] `title` 清晰描述 UI 流程范围
|
|
9
|
+
- [ ] `version` 字段存在且符合语义化版本
|
|
10
|
+
- [ ] `status` 字段存在且为有效值
|
|
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
|
+
- [ ] ARIA 标签完整
|
|
43
|
+
- [ ] 键盘导航支持
|
|
44
|
+
- [ ] 颜色对比度符合标准
|
|
45
|
+
- [ ] 屏幕阅读器兼容
|
|
46
|
+
|
|
47
|
+
## 响应式设计
|
|
48
|
+
|
|
49
|
+
- [ ] 断点定义清晰
|
|
50
|
+
- [ ] 各断点布局调整明确
|
|
51
|
+
- [ ] 元素变化有说明
|
|
52
|
+
- [ ] 移动端交互适配
|
|
53
|
+
|
|
54
|
+
## 性能要求
|
|
55
|
+
|
|
56
|
+
- [ ] 性能指标有明确目标
|
|
57
|
+
- [ ] 测量方式有说明
|
|
58
|
+
- [ ] 关键路径有优化策略
|
|
59
|
+
|
|
60
|
+
## 追溯性
|
|
61
|
+
|
|
62
|
+
- [ ] 关联功能特性存在
|
|
63
|
+
- [ ] UI 流程可追溯到业务需求
|
|
64
|
+
- [ ] 与 API 契约关联清晰
|
|
65
|
+
|
|
66
|
+
## 实现一致性
|
|
67
|
+
|
|
68
|
+
- [ ] 与实际实现代码一致
|
|
69
|
+
- [ ] 文档与实际行为匹配
|
|
70
|
+
- [ ] 设计稿与文档描述一致
|
|
@@ -0,0 +1,150 @@
|
|
|
1
|
+
---
|
|
2
|
+
id: {UI_ID}
|
|
3
|
+
title: {UI 流程名称}
|
|
4
|
+
status: draft
|
|
5
|
+
version: {v1}
|
|
6
|
+
related_features: []
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
# {UI_ID}: {UI 流程名称}
|
|
10
|
+
|
|
11
|
+
<!-- 本模板是插件 starter 指导,项目本地模板可完全覆盖 -->
|
|
12
|
+
<!-- 插件模板是入门指导,项目本地模板是权威 -->
|
|
13
|
+
|
|
14
|
+
## 概述
|
|
15
|
+
|
|
16
|
+
{描述这个 UI 流程的用途、目标用户和核心交互}
|
|
17
|
+
|
|
18
|
+
## 基础信息
|
|
19
|
+
|
|
20
|
+
- **版本**:{version}
|
|
21
|
+
- **适用平台**:Web / Desktop / Mobile
|
|
22
|
+
- **页面/组件**:{页面或组件名称}
|
|
23
|
+
- **入口**:{用户如何进入此流程}
|
|
24
|
+
|
|
25
|
+
## 用户流程
|
|
26
|
+
|
|
27
|
+
### 主流程
|
|
28
|
+
|
|
29
|
+
```
|
|
30
|
+
用户操作 → 系统响应 → 下一步
|
|
31
|
+
↓
|
|
32
|
+
[步骤 1] {操作描述}
|
|
33
|
+
↓
|
|
34
|
+
[步骤 2] {系统响应}
|
|
35
|
+
↓
|
|
36
|
+
[步骤 3] {后续操作}
|
|
37
|
+
↓
|
|
38
|
+
[完成] {最终状态}
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
### 分支流程
|
|
42
|
+
|
|
43
|
+
| 条件 | 分支路径 | 说明 |
|
|
44
|
+
|------|---------|------|
|
|
45
|
+
| {条件描述} | {分支路径} | {说明} |
|
|
46
|
+
|
|
47
|
+
## 状态转换
|
|
48
|
+
|
|
49
|
+
### 状态列表
|
|
50
|
+
|
|
51
|
+
| 状态 | 描述 | 可转换到 |
|
|
52
|
+
|------|------|---------|
|
|
53
|
+
| initial | 初始状态 | loading, ready |
|
|
54
|
+
| loading | 加载中 | ready, error |
|
|
55
|
+
| ready | 就绪状态 | loading, completed |
|
|
56
|
+
| error | 错误状态 | loading, ready |
|
|
57
|
+
| completed | 完成状态 | - |
|
|
58
|
+
|
|
59
|
+
### 状态转换图
|
|
60
|
+
|
|
61
|
+
```
|
|
62
|
+
[initial] → [loading] → [ready] → [completed]
|
|
63
|
+
↓ ↓
|
|
64
|
+
[error] ←--------
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
## 交互元素
|
|
68
|
+
|
|
69
|
+
### 表单元素
|
|
70
|
+
|
|
71
|
+
| 元素 | 类型 | 必填 | 验证规则 | 错误提示 |
|
|
72
|
+
|------|------|------|---------|---------|
|
|
73
|
+
| {字段名} | {input/select/checkbox} | {yes/no} | {验证规则} | {错误提示} |
|
|
74
|
+
|
|
75
|
+
### 按钮和操作
|
|
76
|
+
|
|
77
|
+
| 按钮 | 位置 | 行为 | 禁用条件 |
|
|
78
|
+
|------|------|------|---------|
|
|
79
|
+
| {按钮名} | {位置} | {点击后行为} | {何时禁用} |
|
|
80
|
+
|
|
81
|
+
### 快捷键
|
|
82
|
+
|
|
83
|
+
| 快捷键 | 功能 | 适用场景 |
|
|
84
|
+
|--------|------|---------|
|
|
85
|
+
| {快捷键} | {功能} | {场景} |
|
|
86
|
+
|
|
87
|
+
## 错误处理
|
|
88
|
+
|
|
89
|
+
### 错误类型
|
|
90
|
+
|
|
91
|
+
| 错误类型 | 触发条件 | 用户提示 | 恢复方式 |
|
|
92
|
+
|---------|---------|---------|---------|
|
|
93
|
+
| 网络错误 | 网络请求失败 | "网络连接失败,请重试" | 重试按钮 |
|
|
94
|
+
| 验证错误 | 输入不符合规则 | {字段级错误提示} | 修正输入 |
|
|
95
|
+
| 权限错误 | 无操作权限 | "无权限执行此操作" | 联系管理员 |
|
|
96
|
+
| 服务器错误 | 后端返回错误 | "服务暂时不可用" | 重试或稍后再试 |
|
|
97
|
+
|
|
98
|
+
### 错误展示
|
|
99
|
+
|
|
100
|
+
- **字段级错误**:在对应字段下方显示红色提示
|
|
101
|
+
- **页面级错误**:顶部 Toast 或 Alert 组件
|
|
102
|
+
- **阻断级错误**:模态对话框,需用户确认
|
|
103
|
+
|
|
104
|
+
## 可访问性
|
|
105
|
+
|
|
106
|
+
### ARIA 标签
|
|
107
|
+
|
|
108
|
+
| 元素 | aria-label | aria-describedby |
|
|
109
|
+
|------|-----------|------------------|
|
|
110
|
+
| {元素} | {标签} | {描述元素 ID} |
|
|
111
|
+
|
|
112
|
+
### 键盘导航
|
|
113
|
+
|
|
114
|
+
- Tab 顺序:{说明 Tab 键导航顺序}
|
|
115
|
+
- 焦点管理:{说明焦点如何移动}
|
|
116
|
+
- 屏幕阅读器:{说明屏幕阅读器如何播报}
|
|
117
|
+
|
|
118
|
+
### 视觉设计
|
|
119
|
+
|
|
120
|
+
- 颜色对比度:符合 WCAG 2.1 AA 标准
|
|
121
|
+
- 字体大小:最小 14px
|
|
122
|
+
- 点击区域:最小 44x44px
|
|
123
|
+
|
|
124
|
+
## 响应式设计
|
|
125
|
+
|
|
126
|
+
| 断点 | 布局调整 | 元素变化 |
|
|
127
|
+
|------|---------|---------|
|
|
128
|
+
| Desktop (>1200px) | {布局描述} | {元素变化} |
|
|
129
|
+
| Tablet (768-1200px) | {布局描述} | {元素变化} |
|
|
130
|
+
| Mobile (<768px) | {布局描述} | {元素变化} |
|
|
131
|
+
|
|
132
|
+
## 性能要求
|
|
133
|
+
|
|
134
|
+
| 指标 | 目标值 | 测量方式 |
|
|
135
|
+
|------|-------|---------|
|
|
136
|
+
| 首屏加载 | < {X} 秒 | Lighthouse |
|
|
137
|
+
| 交互响应 | < {X} 毫秒 | 用户感知 |
|
|
138
|
+
| 动画流畅 | 60fps | DevTools |
|
|
139
|
+
|
|
140
|
+
## 关联制品
|
|
141
|
+
|
|
142
|
+
- 功能特性:{related_features}
|
|
143
|
+
- 设计文档:{related_designs}
|
|
144
|
+
- API 契约:{related_api_contracts}
|
|
145
|
+
|
|
146
|
+
## 变更日志
|
|
147
|
+
|
|
148
|
+
| 日期 | 版本 | 变更 | 作者 |
|
|
149
|
+
|------|------|------|------|
|
|
150
|
+
| {YYYY-MM-DD} | v1 | 初始版本 | {作者} |
|
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
# Database Migration 审查清单
|
|
2
|
+
|
|
3
|
+
<!-- 本清单是插件通用基线,项目本地审查规则可覆盖 -->
|
|
4
|
+
|
|
5
|
+
## 结构完整性
|
|
6
|
+
|
|
7
|
+
- [ ] `id` 字段存在且符合项目 ID 模式(如 `MIG-{nnn}` 或时间戳)
|
|
8
|
+
- [ ] `title` 清晰描述迁移内容
|
|
9
|
+
- [ ] `database` 已指定
|
|
10
|
+
- [ ] 迁移类型已标注(DDL / DML / 混合)
|
|
11
|
+
|
|
12
|
+
## SQL 质量
|
|
13
|
+
|
|
14
|
+
- [ ] 正向迁移 SQL 语法正确
|
|
15
|
+
- [ ] 回滚 SQL 语法正确且与正向迁移对称
|
|
16
|
+
- [ ] SQL 已在测试环境验证
|
|
17
|
+
- [ ] 无硬编码环境变量或凭证
|
|
18
|
+
|
|
19
|
+
## 兼容性与安全
|
|
20
|
+
|
|
21
|
+
- [ ] 向前/向后兼容性已分析
|
|
22
|
+
- [ ] 应用停机需求已明确
|
|
23
|
+
- [ ] NOT NULL 约束处理策略已说明
|
|
24
|
+
- [ ] 默认值策略合理
|
|
25
|
+
|
|
26
|
+
## 回滚方案
|
|
27
|
+
|
|
28
|
+
- [ ] 回滚 SQL 完整可执行
|
|
29
|
+
- [ ] 回滚触发条件明确
|
|
30
|
+
- [ ] 回滚窗口已定义
|
|
31
|
+
- [ ] 回滚数据丢失风险已评估
|
|
32
|
+
|
|
33
|
+
## 性能影响
|
|
34
|
+
|
|
35
|
+
- [ ] 锁策略已评估
|
|
36
|
+
- [ ] 大表变更策略已说明(分批 / 在线 DDL)
|
|
37
|
+
- [ ] 预估执行时间合理
|
|
38
|
+
- [ ] 迁移期间监控方案已定义
|
|
39
|
+
|
|
40
|
+
## 验证方案
|
|
41
|
+
|
|
42
|
+
- [ ] 迁移前检查项完整
|
|
43
|
+
- [ ] 迁移后验证步骤可执行
|
|
44
|
+
- [ ] 数据完整性校验方案存在
|
|
45
|
+
- [ ] 回归测试覆盖关键场景
|
|
46
|
+
|
|
47
|
+
## 追溯性
|
|
48
|
+
|
|
49
|
+
- [ ] 关联数据契约存在
|
|
50
|
+
- [ ] 关联功能特性存在
|
|
51
|
+
- [ ] 迁移可追溯到 schema 变更原因
|