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,133 @@
|
|
|
1
|
+
---
|
|
2
|
+
id: {SKILL_ID}
|
|
3
|
+
title: {技能名称}
|
|
4
|
+
status: draft
|
|
5
|
+
related_features: []
|
|
6
|
+
related_decisions: []
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
# {SKILL_ID}: {技能名称}
|
|
10
|
+
|
|
11
|
+
<!-- 本模板是插件 starter 指导,项目本地模板可完全覆盖 -->
|
|
12
|
+
<!-- 插件模板是入门指导,项目本地模板是权威 -->
|
|
13
|
+
|
|
14
|
+
## 概述
|
|
15
|
+
|
|
16
|
+
{描述这个 Agent 技能的用途、触发条件和主要能力}
|
|
17
|
+
|
|
18
|
+
## 技能元信息
|
|
19
|
+
|
|
20
|
+
- **名称**:{skill_name}
|
|
21
|
+
- **描述**:{description}
|
|
22
|
+
- **触发条件**:{触发条件}
|
|
23
|
+
- **适用场景**:{适用场景}
|
|
24
|
+
|
|
25
|
+
## 输入契约
|
|
26
|
+
|
|
27
|
+
### 必需输入
|
|
28
|
+
|
|
29
|
+
| 参数 | 类型 | 描述 |
|
|
30
|
+
|------|------|------|
|
|
31
|
+
| {param1} | {type} | {描述} |
|
|
32
|
+
| {param2} | {type} | {描述} |
|
|
33
|
+
|
|
34
|
+
### 可选输入
|
|
35
|
+
|
|
36
|
+
| 参数 | 类型 | 默认值 | 描述 |
|
|
37
|
+
|------|------|--------|------|
|
|
38
|
+
| {param3} | {type} | {默认值} | {描述} |
|
|
39
|
+
|
|
40
|
+
## 输出契约
|
|
41
|
+
|
|
42
|
+
### 成功输出
|
|
43
|
+
|
|
44
|
+
```json
|
|
45
|
+
{
|
|
46
|
+
"success": true,
|
|
47
|
+
"data": {
|
|
48
|
+
"field1": "value",
|
|
49
|
+
"field2": "value"
|
|
50
|
+
}
|
|
51
|
+
}
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
### 错误输出
|
|
55
|
+
|
|
56
|
+
```json
|
|
57
|
+
{
|
|
58
|
+
"success": false,
|
|
59
|
+
"error": {
|
|
60
|
+
"code": "ERROR_CODE",
|
|
61
|
+
"message": "错误描述"
|
|
62
|
+
}
|
|
63
|
+
}
|
|
64
|
+
```
|
|
65
|
+
|
|
66
|
+
## 处理流程
|
|
67
|
+
|
|
68
|
+
### 步骤 1:{步骤标题}
|
|
69
|
+
|
|
70
|
+
**目的**:{步骤目的}
|
|
71
|
+
|
|
72
|
+
**输入**:{输入}
|
|
73
|
+
**处理**:{处理逻辑}
|
|
74
|
+
**输出**:{输出}
|
|
75
|
+
|
|
76
|
+
### 步骤 2:{步骤标题}
|
|
77
|
+
|
|
78
|
+
{同上结构}
|
|
79
|
+
|
|
80
|
+
## 工具依赖
|
|
81
|
+
|
|
82
|
+
| 工具 | 用途 | 权限要求 |
|
|
83
|
+
|------|------|---------|
|
|
84
|
+
| {tool1} | {用途} | {权限} |
|
|
85
|
+
| {tool2} | {用途} | {权限} |
|
|
86
|
+
|
|
87
|
+
## 权限边界
|
|
88
|
+
|
|
89
|
+
- **可访问资源**:{资源列表}
|
|
90
|
+
- **禁止操作**:{禁止列表}
|
|
91
|
+
- **数据访问范围**:{范围}
|
|
92
|
+
|
|
93
|
+
## 错误处理
|
|
94
|
+
|
|
95
|
+
| 错误码 | 描述 | 处理方式 |
|
|
96
|
+
|--------|------|---------|
|
|
97
|
+
| INVALID_INPUT | 输入无效 | 返回错误详情 |
|
|
98
|
+
| PERMISSION_DENIED | 权限不足 | 提示权限要求 |
|
|
99
|
+
| TOOL_ERROR | 工具调用失败 | 重试或降级 |
|
|
100
|
+
|
|
101
|
+
## 示例
|
|
102
|
+
|
|
103
|
+
### 示例 1:{场景描述}
|
|
104
|
+
|
|
105
|
+
**输入**:
|
|
106
|
+
```json
|
|
107
|
+
{
|
|
108
|
+
"param1": "value1",
|
|
109
|
+
"param2": "value2"
|
|
110
|
+
}
|
|
111
|
+
```
|
|
112
|
+
|
|
113
|
+
**输出**:
|
|
114
|
+
```json
|
|
115
|
+
{
|
|
116
|
+
"success": true,
|
|
117
|
+
"data": {
|
|
118
|
+
"result": "处理结果"
|
|
119
|
+
}
|
|
120
|
+
}
|
|
121
|
+
```
|
|
122
|
+
|
|
123
|
+
## 关联制品
|
|
124
|
+
|
|
125
|
+
- 功能特性:{related_features}
|
|
126
|
+
- 决策:{related_decisions}
|
|
127
|
+
- 设计文档:{related_designs}
|
|
128
|
+
|
|
129
|
+
## 变更日志
|
|
130
|
+
|
|
131
|
+
| 日期 | 变更 | 作者 |
|
|
132
|
+
|------|------|------|
|
|
133
|
+
| {YYYY-MM-DD} | 初始草稿 | {作者} |
|
|
@@ -0,0 +1,58 @@
|
|
|
1
|
+
# Hook Policy 审查清单
|
|
2
|
+
|
|
3
|
+
<!-- 本清单是插件通用基线,项目本地审查规则可覆盖 -->
|
|
4
|
+
|
|
5
|
+
## 结构完整性
|
|
6
|
+
|
|
7
|
+
- [ ] `id` 字段存在且符合项目 ID 模式(如 `HOOK-{nnn}`)
|
|
8
|
+
- [ ] `title` 清晰描述策略范围
|
|
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
|
+
|
|
42
|
+
- [ ] 审计日志格式完整
|
|
43
|
+
- [ ] 日志存储位置合理
|
|
44
|
+
- [ ] 监控指标已配置
|
|
45
|
+
- [ ] 告警阈值合理
|
|
46
|
+
|
|
47
|
+
## 追溯性
|
|
48
|
+
|
|
49
|
+
- [ ] 关联功能特性存在
|
|
50
|
+
- [ ] 关联决策存在
|
|
51
|
+
- [ ] 策略可追溯到安全需求
|
|
52
|
+
|
|
53
|
+
## 安全性
|
|
54
|
+
|
|
55
|
+
- [ ] 无硬编码凭证
|
|
56
|
+
- [ ] 权限最小化
|
|
57
|
+
- [ ] 敏感操作有审计
|
|
58
|
+
- [ ] 绕过有审批记录
|
|
@@ -0,0 +1,134 @@
|
|
|
1
|
+
---
|
|
2
|
+
id: {HOOK_ID}
|
|
3
|
+
title: {Hook 策略标题}
|
|
4
|
+
status: draft
|
|
5
|
+
related_features: []
|
|
6
|
+
related_decisions: []
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
# {HOOK_ID}: {Hook 策略标题}
|
|
10
|
+
|
|
11
|
+
<!-- 本模板是插件 starter 指导,项目本地模板可完全覆盖 -->
|
|
12
|
+
<!-- 插件模板是入门指导,项目本地模板是权威 -->
|
|
13
|
+
|
|
14
|
+
## 概述
|
|
15
|
+
|
|
16
|
+
{描述这个 Hook 策略的用途、适用范围和主要约束}
|
|
17
|
+
|
|
18
|
+
## 策略信息
|
|
19
|
+
|
|
20
|
+
- **策略名称**:{policy_name}
|
|
21
|
+
- **适用范围**:{适用范围}
|
|
22
|
+
- **优先级**:{优先级}
|
|
23
|
+
- **执行阶段**:{pre-commit/post-commit/pre-push 等}
|
|
24
|
+
|
|
25
|
+
## 触发条件
|
|
26
|
+
|
|
27
|
+
### 触发事件
|
|
28
|
+
|
|
29
|
+
| 事件 | 触发条件 | 执行频率 |
|
|
30
|
+
|------|---------|---------|
|
|
31
|
+
| {事件1} | {条件} | {频率} |
|
|
32
|
+
| {事件2} | {条件} | {频率} |
|
|
33
|
+
|
|
34
|
+
### 排除条件
|
|
35
|
+
|
|
36
|
+
- {排除条件 1}
|
|
37
|
+
- {排除条件 2}
|
|
38
|
+
|
|
39
|
+
## 门禁规则
|
|
40
|
+
|
|
41
|
+
### 规则 1:{规则名称}
|
|
42
|
+
|
|
43
|
+
**描述**:{规则描述}
|
|
44
|
+
|
|
45
|
+
**检查内容**:
|
|
46
|
+
- {检查项 1}
|
|
47
|
+
- {检查项 2}
|
|
48
|
+
|
|
49
|
+
**通过条件**:{通过条件}
|
|
50
|
+
|
|
51
|
+
**失败处理**:{失败处理方式}
|
|
52
|
+
|
|
53
|
+
### 规则 2:{规则名称}
|
|
54
|
+
|
|
55
|
+
{同上结构}
|
|
56
|
+
|
|
57
|
+
## 绕过审批
|
|
58
|
+
|
|
59
|
+
### 绕过条件
|
|
60
|
+
|
|
61
|
+
{描述什么情况下可以绕过此策略}
|
|
62
|
+
|
|
63
|
+
### 审批流程
|
|
64
|
+
|
|
65
|
+
1. {审批步骤 1}
|
|
66
|
+
2. {审批步骤 2}
|
|
67
|
+
|
|
68
|
+
### 审批记录
|
|
69
|
+
|
|
70
|
+
| 日期 | 申请人 | 审批人 | 原因 | 有效期 |
|
|
71
|
+
|------|--------|--------|------|--------|
|
|
72
|
+
| {日期} | {申请人} | {审批人} | {原因} | {有效期} |
|
|
73
|
+
|
|
74
|
+
## 执行脚本
|
|
75
|
+
|
|
76
|
+
```bash
|
|
77
|
+
#!/bin/bash
|
|
78
|
+
# Hook 执行脚本
|
|
79
|
+
|
|
80
|
+
# 检查条件
|
|
81
|
+
if [条件]; then
|
|
82
|
+
# 执行检查
|
|
83
|
+
{检查命令}
|
|
84
|
+
|
|
85
|
+
# 验证结果
|
|
86
|
+
if [验证条件]; then
|
|
87
|
+
echo "检查通过"
|
|
88
|
+
exit 0
|
|
89
|
+
else
|
|
90
|
+
echo "检查失败"
|
|
91
|
+
exit 1
|
|
92
|
+
fi
|
|
93
|
+
fi
|
|
94
|
+
```
|
|
95
|
+
|
|
96
|
+
## 审计日志
|
|
97
|
+
|
|
98
|
+
### 日志格式
|
|
99
|
+
|
|
100
|
+
```json
|
|
101
|
+
{
|
|
102
|
+
"timestamp": "ISO8601",
|
|
103
|
+
"hook": "{hook_name}",
|
|
104
|
+
"event": "{event}",
|
|
105
|
+
"result": "pass/fail",
|
|
106
|
+
"user": "{user}",
|
|
107
|
+
"details": {}
|
|
108
|
+
}
|
|
109
|
+
```
|
|
110
|
+
|
|
111
|
+
### 日志存储
|
|
112
|
+
|
|
113
|
+
- **位置**:{日志路径}
|
|
114
|
+
- **保留期**:{保留期限}
|
|
115
|
+
- **轮转策略**:{轮转策略}
|
|
116
|
+
|
|
117
|
+
## 监控与告警
|
|
118
|
+
|
|
119
|
+
| 指标 | 阈值 | 告警方式 |
|
|
120
|
+
|------|------|---------|
|
|
121
|
+
| 执行失败率 | < 5% | {告警方式} |
|
|
122
|
+
| 执行时间 | < 10s | {告警方式} |
|
|
123
|
+
|
|
124
|
+
## 关联制品
|
|
125
|
+
|
|
126
|
+
- 功能特性:{related_features}
|
|
127
|
+
- 决策:{related_decisions}
|
|
128
|
+
- 设计文档:{related_designs}
|
|
129
|
+
|
|
130
|
+
## 变更日志
|
|
131
|
+
|
|
132
|
+
| 日期 | 变更 | 作者 |
|
|
133
|
+
|------|------|------|
|
|
134
|
+
| {YYYY-MM-DD} | 初始版本 | {作者} |
|
|
@@ -0,0 +1,54 @@
|
|
|
1
|
+
# Prompt Packet 审查清单
|
|
2
|
+
|
|
3
|
+
<!-- 本清单是插件通用基线,项目本地审查规则可覆盖 -->
|
|
4
|
+
|
|
5
|
+
## 结构完整性
|
|
6
|
+
|
|
7
|
+
- [ ] `id` 字段存在且符合项目 ID 模式(如 `PP-{nnn}`)
|
|
8
|
+
- [ ] `title` 清晰描述 Prompt Packet 用途
|
|
9
|
+
- [ ] 适用场景已定义
|
|
10
|
+
- [ ] 目标 Agent/工具已指定
|
|
11
|
+
|
|
12
|
+
## 上下文组装质量
|
|
13
|
+
|
|
14
|
+
- [ ] 必需上下文来源已列出
|
|
15
|
+
- [ ] 上下文来源的类型和路径可解析
|
|
16
|
+
- [ ] 可选上下文有明确增强效果说明
|
|
17
|
+
- [ ] 无冗余或冲突的上下文来源
|
|
18
|
+
|
|
19
|
+
## Prompt 模板质量
|
|
20
|
+
|
|
21
|
+
- [ ] 系统提示覆盖角色和约束
|
|
22
|
+
- [ ] 用户提示结构清晰
|
|
23
|
+
- [ ] 占位符有明确来源和填充规则
|
|
24
|
+
- [ ] Prompt 模板无歧义指令
|
|
25
|
+
|
|
26
|
+
## 输出契约
|
|
27
|
+
|
|
28
|
+
- [ ] 期望输出格式已定义
|
|
29
|
+
- [ ] 质量标准可验证
|
|
30
|
+
- [ ] 输出格式与下游消费方匹配
|
|
31
|
+
|
|
32
|
+
## 组装流程
|
|
33
|
+
|
|
34
|
+
- [ ] 组装步骤清晰
|
|
35
|
+
- [ ] 每步有明确输入/输出
|
|
36
|
+
- [ ] 组装流程可自动化或半自动化执行
|
|
37
|
+
|
|
38
|
+
## 使用约束
|
|
39
|
+
|
|
40
|
+
- [ ] Token 预算已估算
|
|
41
|
+
- [ ] 更新频率合理
|
|
42
|
+
- [ ] 适用范围和排除情况已定义
|
|
43
|
+
|
|
44
|
+
## 追溯性
|
|
45
|
+
|
|
46
|
+
- [ ] 关联功能特性存在
|
|
47
|
+
- [ ] 关联决策存在
|
|
48
|
+
- [ ] Prompt Packet 可追溯到用户需求
|
|
49
|
+
|
|
50
|
+
## 可测试性
|
|
51
|
+
|
|
52
|
+
- [ ] 示例输入/输出完整
|
|
53
|
+
- [ ] 可在目标 Agent 环境中实际运行
|
|
54
|
+
- [ ] 输出质量可回归验证
|
|
@@ -0,0 +1,106 @@
|
|
|
1
|
+
---
|
|
2
|
+
id: {PP_ID}
|
|
3
|
+
title: {Prompt Packet 标题}
|
|
4
|
+
status: draft
|
|
5
|
+
related_features: []
|
|
6
|
+
related_decisions: []
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
# {PP_ID}: {Prompt Packet 标题}
|
|
10
|
+
|
|
11
|
+
<!-- 本模板是插件 starter 指导,项目本地模板可完全覆盖 -->
|
|
12
|
+
<!-- 插件模板是入门指导,项目本地模板是权威 -->
|
|
13
|
+
|
|
14
|
+
## 概述
|
|
15
|
+
|
|
16
|
+
{描述这个 Prompt Packet 的用途:为哪个 AI 辅助任务组装上下文,解决什么问题}
|
|
17
|
+
|
|
18
|
+
## 元信息
|
|
19
|
+
|
|
20
|
+
- **名称**:{packet_name}
|
|
21
|
+
- **描述**:{description}
|
|
22
|
+
- **适用场景**:{使用场景}
|
|
23
|
+
- **目标 Agent/工具**:{Claude Code / Codex / 其他}
|
|
24
|
+
|
|
25
|
+
## 上下文组装
|
|
26
|
+
|
|
27
|
+
### 必需上下文
|
|
28
|
+
|
|
29
|
+
| 来源 | 类型 | 说明 |
|
|
30
|
+
|------|------|------|
|
|
31
|
+
| {source1} | {制品类型} | {为什么需要} |
|
|
32
|
+
| {source2} | {制品类型} | {为什么需要} |
|
|
33
|
+
|
|
34
|
+
### 可选上下文
|
|
35
|
+
|
|
36
|
+
| 来源 | 类型 | 说明 |
|
|
37
|
+
|------|------|------|
|
|
38
|
+
| {source3} | {制品类型} | {增强效果} |
|
|
39
|
+
|
|
40
|
+
## Prompt 模板
|
|
41
|
+
|
|
42
|
+
### 系统提示
|
|
43
|
+
|
|
44
|
+
```
|
|
45
|
+
{系统提示内容}
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
### 用户提示
|
|
49
|
+
|
|
50
|
+
```
|
|
51
|
+
{用户提示内容}
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
### 上下文注入点
|
|
55
|
+
|
|
56
|
+
| 占位符 | 来源 | 填充规则 |
|
|
57
|
+
|--------|------|---------|
|
|
58
|
+
| `{placeholder1}` | {source} | {规则} |
|
|
59
|
+
| `{placeholder2}` | {source} | {规则} |
|
|
60
|
+
|
|
61
|
+
## 输出契约
|
|
62
|
+
|
|
63
|
+
### 期望输出格式
|
|
64
|
+
|
|
65
|
+
```json
|
|
66
|
+
{
|
|
67
|
+
"result": "期望输出结构"
|
|
68
|
+
}
|
|
69
|
+
```
|
|
70
|
+
|
|
71
|
+
### 质量标准
|
|
72
|
+
|
|
73
|
+
- {标准1}
|
|
74
|
+
- {标准2}
|
|
75
|
+
|
|
76
|
+
## 组装流程
|
|
77
|
+
|
|
78
|
+
### 步骤 1:{步骤标题}
|
|
79
|
+
|
|
80
|
+
**目的**:{步骤目的}
|
|
81
|
+
|
|
82
|
+
**输入**:{输入}
|
|
83
|
+
**处理**:{处理逻辑}
|
|
84
|
+
**输出**:{输出}
|
|
85
|
+
|
|
86
|
+
### 步骤 2:{步骤标题}
|
|
87
|
+
|
|
88
|
+
{同上结构}
|
|
89
|
+
|
|
90
|
+
## 使用约束
|
|
91
|
+
|
|
92
|
+
- **Token 预算**:{预期 token 消耗范围}
|
|
93
|
+
- **更新频率**:{多久需要重新组装}
|
|
94
|
+
- **适用范围**:{不适用的情况}
|
|
95
|
+
|
|
96
|
+
## 关联制品
|
|
97
|
+
|
|
98
|
+
- 功能特性:{related_features}
|
|
99
|
+
- 决策:{related_decisions}
|
|
100
|
+
- Agent 技能:{关联的 agent_skill 制品}
|
|
101
|
+
|
|
102
|
+
## 变更日志
|
|
103
|
+
|
|
104
|
+
| 日期 | 变更 | 作者 |
|
|
105
|
+
|------|------|------|
|
|
106
|
+
| {YYYY-MM-DD} | 初始草稿 | {作者} |
|
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
# API Contract 审查清单
|
|
2
|
+
|
|
3
|
+
<!-- 本清单是插件通用基线,项目本地审查规则可覆盖 -->
|
|
4
|
+
|
|
5
|
+
## 结构完整性
|
|
6
|
+
|
|
7
|
+
- [ ] `id` 字段存在且符合项目 ID 模式(如 `API-{nnn}` 或 `{service}-API-{version}`)
|
|
8
|
+
- [ ] `title` 清晰描述 API 范围
|
|
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
|
+
- [ ] API 可追溯到业务需求
|
|
37
|
+
- [ ] 版本变更可追溯
|
|
38
|
+
|
|
39
|
+
## 实现一致性
|
|
40
|
+
|
|
41
|
+
- [ ] 与实现代码一致
|
|
42
|
+
- [ ] 文档与实际行为匹配
|
|
43
|
+
- [ ] 测试覆盖所有端点
|
|
@@ -0,0 +1,92 @@
|
|
|
1
|
+
---
|
|
2
|
+
id: {API_ID}
|
|
3
|
+
title: {API 名称}
|
|
4
|
+
status: draft
|
|
5
|
+
version: {v1}
|
|
6
|
+
base_url: {基础 URL}
|
|
7
|
+
related_features: []
|
|
8
|
+
---
|
|
9
|
+
|
|
10
|
+
# {API_ID}: {API 名称}
|
|
11
|
+
|
|
12
|
+
<!-- 本模板是插件 starter 指导,项目本地模板可完全覆盖 -->
|
|
13
|
+
<!-- 插件模板是入门指导,项目本地模板是权威 -->
|
|
14
|
+
|
|
15
|
+
## 概述
|
|
16
|
+
|
|
17
|
+
{描述这个 API 的用途、范围和主要能力}
|
|
18
|
+
|
|
19
|
+
## 基础信息
|
|
20
|
+
|
|
21
|
+
- **版本**:{version}
|
|
22
|
+
- **Base URL**:{base_url}
|
|
23
|
+
- **协议**:REST / GraphQL / gRPC
|
|
24
|
+
- **认证方式**:{认证方式}
|
|
25
|
+
|
|
26
|
+
## 端点列表
|
|
27
|
+
|
|
28
|
+
### {METHOD} {路径}
|
|
29
|
+
|
|
30
|
+
**描述**:{端点描述}
|
|
31
|
+
|
|
32
|
+
**请求参数**:
|
|
33
|
+
|
|
34
|
+
| 参数 | 类型 | 必填 | 描述 |
|
|
35
|
+
|------|------|------|------|
|
|
36
|
+
| {param} | {type} | {yes/no} | {描述} |
|
|
37
|
+
|
|
38
|
+
**请求体**(如适用):
|
|
39
|
+
|
|
40
|
+
```json
|
|
41
|
+
{
|
|
42
|
+
"field1": "type",
|
|
43
|
+
"field2": "type"
|
|
44
|
+
}
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
**响应**:
|
|
48
|
+
|
|
49
|
+
```json
|
|
50
|
+
{
|
|
51
|
+
"success": true,
|
|
52
|
+
"data": {
|
|
53
|
+
"field1": "value"
|
|
54
|
+
}
|
|
55
|
+
}
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
**错误码**:
|
|
59
|
+
|
|
60
|
+
| 状态码 | 错误码 | 描述 |
|
|
61
|
+
|--------|--------|------|
|
|
62
|
+
| 400 | INVALID_PARAM | 参数无效 |
|
|
63
|
+
| 401 | UNAUTHORIZED | 未认证 |
|
|
64
|
+
| 404 | NOT_FOUND | 资源不存在 |
|
|
65
|
+
|
|
66
|
+
## 数据模型
|
|
67
|
+
|
|
68
|
+
### {Model Name}
|
|
69
|
+
|
|
70
|
+
```json
|
|
71
|
+
{
|
|
72
|
+
"id": "string",
|
|
73
|
+
"name": "string",
|
|
74
|
+
"created_at": "datetime"
|
|
75
|
+
}
|
|
76
|
+
```
|
|
77
|
+
|
|
78
|
+
## 版本兼容性
|
|
79
|
+
|
|
80
|
+
{描述版本兼容策略和破坏性变更规则}
|
|
81
|
+
|
|
82
|
+
## 关联制品
|
|
83
|
+
|
|
84
|
+
- 功能特性:{related_features}
|
|
85
|
+
- 设计文档:{related_designs}
|
|
86
|
+
- 决策:{related_decisions}
|
|
87
|
+
|
|
88
|
+
## 变更日志
|
|
89
|
+
|
|
90
|
+
| 日期 | 版本 | 变更 | 作者 |
|
|
91
|
+
|------|------|------|------|
|
|
92
|
+
| {YYYY-MM-DD} | v1 | 初始版本 | {作者} |
|
|
@@ -0,0 +1,82 @@
|
|
|
1
|
+
# Batch Job Contract 审查清单
|
|
2
|
+
|
|
3
|
+
<!-- 本清单是插件通用基线,项目本地审查规则可覆盖 -->
|
|
4
|
+
|
|
5
|
+
## 结构完整性
|
|
6
|
+
|
|
7
|
+
- [ ] `id` 字段存在且符合项目 ID 模式(如 `BATCH-{nnn}`)
|
|
8
|
+
- [ ] `title` 清晰描述批处理作业范围
|
|
9
|
+
- [ ] `version` 字段存在且符合语义化版本
|
|
10
|
+
- [ ] `status` 字段存在且为有效值
|
|
11
|
+
- [ ] `schedule` 字段存在且为有效 cron 表达式
|
|
12
|
+
|
|
13
|
+
## 输入定义
|
|
14
|
+
|
|
15
|
+
- [ ] 所有数据源已列出
|
|
16
|
+
- [ ] 数据源类型明确(数据库 / 文件 / API / 消息队列)
|
|
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
|
+
- [ ] 错误分类已定义(数据 / 系统 / 业务)
|
|
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
|
+
|
|
72
|
+
- [ ] 关联功能特性存在
|
|
73
|
+
- [ ] 批处理作业可追溯到业务需求
|
|
74
|
+
- [ ] 版本变更可追溯
|
|
75
|
+
- [ ] 关联设计文档存在
|
|
76
|
+
|
|
77
|
+
## 实现一致性
|
|
78
|
+
|
|
79
|
+
- [ ] 与实现代码一致
|
|
80
|
+
- [ ] 文档与实际行为匹配
|
|
81
|
+
- [ ] 测试覆盖核心场景
|
|
82
|
+
- [ ] 性能满足要求
|