universal-dev-standards 6.14.0-beta.9 → 6.14.1-beta.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/bin/uds.js +12 -1
- package/bundled/ai/options/commit-message/traditional-chinese.ai.yaml +69 -67
- package/bundled/ai/standards/commit-message.ai.yaml +12 -2
- package/bundled/ai/standards/mock-boundary.ai.yaml +138 -2
- package/bundled/ai/standards/secret-management-standards.ai.yaml +12 -1
- package/bundled/ai/standards/turn-completion-integrity.ai.yaml +6 -2
- package/bundled/core/commit-message-guide.md +22 -19
- package/bundled/core/mock-boundary.md +70 -2
- package/bundled/core/secret-management-standards.md +13 -1
- package/bundled/core/turn-completion-integrity.md +8 -2
- package/bundled/extensions/locales/zh-tw.md +19 -19
- package/bundled/hooks/check-dangerous-cmd.mjs +161 -26
- package/bundled/hooks/check-logging-standard.mjs +35 -6
- package/bundled/hooks/validate-commit-msg.mjs +317 -28
- package/bundled/locales/zh-CN/CHANGELOG.md +2323 -1099
- package/bundled/locales/zh-CN/CLAUDE.md +987 -101
- package/bundled/locales/zh-CN/README.md +3 -3
- package/bundled/locales/zh-CN/SECURITY.md +4 -3
- package/bundled/locales/zh-CN/STANDARDS-MAPPING.md +103 -6
- package/bundled/locales/zh-CN/adoption/ADOPTION-GUIDE.md +68 -97
- package/bundled/locales/zh-CN/adoption/DAILY-WORKFLOW-GUIDE.md +2 -1
- package/bundled/locales/zh-CN/adoption/STATIC-DYNAMIC-GUIDE.md +8 -9
- package/bundled/locales/zh-CN/adoption/checklists/enterprise.md +81 -80
- package/bundled/locales/zh-CN/adoption/checklists/minimal.md +18 -14
- package/bundled/locales/zh-CN/adoption/checklists/recommended.md +49 -46
- package/bundled/locales/zh-CN/ai/MAINTENANCE.md +44 -9
- package/bundled/locales/zh-CN/ai/options/commit-message/traditional-chinese.ai.yaml +63 -55
- package/bundled/locales/zh-CN/core/acceptance-criteria-traceability.md +61 -14
- package/bundled/locales/zh-CN/core/acceptance-test-driven-development.md +2 -1
- package/bundled/locales/zh-CN/core/accessibility-standards.md +871 -62
- package/bundled/locales/zh-CN/core/adr-standards.md +155 -32
- package/bundled/locales/zh-CN/core/agent-communication-protocol.md +2 -1
- package/bundled/locales/zh-CN/core/agent-dispatch.md +68 -33
- package/bundled/locales/zh-CN/core/ai-agreement-standards.md +23 -22
- package/bundled/locales/zh-CN/core/ai-command-behavior.md +2 -1
- package/bundled/locales/zh-CN/core/ai-friendly-architecture.md +311 -72
- package/bundled/locales/zh-CN/core/ai-instruction-standards.md +71 -49
- package/bundled/locales/zh-CN/core/ai-response-navigation.md +2 -1
- package/bundled/locales/zh-CN/core/alerting-standards.md +231 -36
- package/bundled/locales/zh-CN/core/anti-hallucination.md +116 -697
- package/bundled/locales/zh-CN/core/anti-sycophancy-prompting.md +34 -33
- package/bundled/locales/zh-CN/core/api-design-standards.md +144 -58
- package/bundled/locales/zh-CN/core/behavior-driven-development.md +2 -1
- package/bundled/locales/zh-CN/core/branch-completion.md +75 -20
- package/bundled/locales/zh-CN/core/capability-declaration.md +44 -94
- package/bundled/locales/zh-CN/core/change-batching-standards.md +2 -1
- package/bundled/locales/zh-CN/core/changelog-standards.md +485 -63
- package/bundled/locales/zh-CN/core/chaos-engineering-standards.md +141 -39
- package/bundled/locales/zh-CN/core/checkin-standards.md +176 -116
- package/bundled/locales/zh-CN/core/circuit-breaker.md +43 -77
- package/bundled/locales/zh-CN/core/code-review-checklist.md +37 -23
- package/bundled/locales/zh-CN/core/commit-message-guide.md +892 -69
- package/bundled/locales/zh-CN/core/containerization-standards.md +259 -57
- package/bundled/locales/zh-CN/core/context-aware-loading.md +103 -29
- package/bundled/locales/zh-CN/core/database-standards.md +115 -114
- package/bundled/locales/zh-CN/core/deprecation-standards.md +155 -40
- package/bundled/locales/zh-CN/core/design-document-standards.md +265 -55
- package/bundled/locales/zh-CN/core/developer-memory.md +150 -60
- package/bundled/locales/zh-CN/core/documentation-lifecycle.md +20 -16
- package/bundled/locales/zh-CN/core/documentation-structure.md +1284 -127
- package/bundled/locales/zh-CN/core/documentation-writing-standards.md +649 -259
- package/bundled/locales/zh-CN/core/dual-phase-output.md +37 -70
- package/bundled/locales/zh-CN/core/environment-standards.md +251 -73
- package/bundled/locales/zh-CN/core/error-code-standards.md +501 -60
- package/bundled/locales/zh-CN/core/estimation-standards.md +174 -41
- package/bundled/locales/zh-CN/core/execution-history.md +2 -1
- package/bundled/locales/zh-CN/core/failure-source-taxonomy.md +71 -84
- package/bundled/locales/zh-CN/core/feature-flag-standards.md +202 -57
- package/bundled/locales/zh-CN/core/forward-derivation-standards.md +613 -154
- package/bundled/locales/zh-CN/core/frontend-design-standards.md +361 -78
- package/bundled/locales/zh-CN/core/git-workflow.md +148 -262
- package/bundled/locales/zh-CN/core/git-worktree.md +59 -26
- package/bundled/locales/zh-CN/core/guides/file-placement-guide.md +132 -48
- package/bundled/locales/zh-CN/core/guides/performance-guide.md +61 -59
- package/bundled/locales/zh-CN/core/guides/security-guide.md +2 -0
- package/bundled/locales/zh-CN/core/health-check-standards.md +46 -104
- package/bundled/locales/zh-CN/core/immutability-first.md +83 -60
- package/bundled/locales/zh-CN/core/knowledge-transfer-standards.md +94 -31
- package/bundled/locales/zh-CN/core/mock-boundary.md +74 -6
- package/bundled/locales/zh-CN/core/mutation-testing.md +45 -6
- package/bundled/locales/zh-CN/core/observability-standards.md +281 -37
- package/bundled/locales/zh-CN/core/performance-standards.md +402 -42
- package/bundled/locales/zh-CN/core/pipeline-integration-standards.md +2 -1
- package/bundled/locales/zh-CN/core/postmortem-standards.md +358 -53
- package/bundled/locales/zh-CN/core/privacy-standards.md +148 -40
- package/bundled/locales/zh-CN/core/project-context-memory.md +182 -48
- package/bundled/locales/zh-CN/core/project-structure.md +550 -170
- package/bundled/locales/zh-CN/core/recovery-recipe-registry.md +54 -114
- package/bundled/locales/zh-CN/core/refactoring-standards.md +141 -556
- package/bundled/locales/zh-CN/core/requirement-engineering.md +7 -6
- package/bundled/locales/zh-CN/core/retrospective-standards.md +215 -22
- package/bundled/locales/zh-CN/core/retry-standards.md +46 -101
- package/bundled/locales/zh-CN/core/reverse-engineering-standards.md +370 -120
- package/bundled/locales/zh-CN/core/runbook-standards.md +294 -48
- package/bundled/locales/zh-CN/core/security-decision.md +45 -70
- package/bundled/locales/zh-CN/core/security-standards.md +169 -16
- package/bundled/locales/zh-CN/core/skill-standard-alignment-check.md +105 -71
- package/bundled/locales/zh-CN/core/slo-standards.md +296 -44
- package/bundled/locales/zh-CN/core/spec-driven-development.md +37 -6
- package/bundled/locales/zh-CN/core/standard-admission-criteria.md +25 -31
- package/bundled/locales/zh-CN/core/standard-lifecycle-management.md +49 -57
- package/bundled/locales/zh-CN/core/structured-task-definition.md +2 -1
- package/bundled/locales/zh-CN/core/supply-chain-security-standards.md +159 -32
- package/bundled/locales/zh-CN/core/systematic-debugging.md +87 -42
- package/bundled/locales/zh-CN/core/tech-debt-standards.md +202 -86
- package/bundled/locales/zh-CN/core/test-completeness-dimensions.md +262 -190
- package/bundled/locales/zh-CN/core/test-data-standards.md +252 -30
- package/bundled/locales/zh-CN/core/test-driven-development.md +21 -1022
- package/bundled/locales/zh-CN/core/test-governance.md +94 -43
- package/bundled/locales/zh-CN/core/testing-standards.md +83 -37
- package/bundled/locales/zh-CN/core/timeout-standards.md +45 -85
- package/bundled/locales/zh-CN/core/token-budget.md +44 -80
- package/bundled/locales/zh-CN/core/translation-lifecycle-standards.md +48 -36
- package/bundled/locales/zh-CN/core/turn-completion-integrity.md +8 -6
- package/bundled/locales/zh-CN/core/verification-evidence.md +44 -22
- package/bundled/locales/zh-CN/core/versioning.md +737 -73
- package/bundled/locales/zh-CN/core/virtual-organization-standards.md +30 -29
- package/bundled/locales/zh-CN/core/workflow-enforcement.md +9 -8
- package/bundled/locales/zh-CN/core/workflow-state-protocol.md +9 -8
- package/bundled/locales/zh-CN/docs/CHEATSHEET.md +2 -1
- package/bundled/locales/zh-CN/docs/CLI-FLOW.md +2 -1
- package/bundled/locales/zh-CN/docs/CLI-INIT-OPTIONS.md +19 -10
- package/bundled/locales/zh-CN/docs/FEATURE-REFERENCE.md +8 -6
- package/bundled/locales/zh-CN/docs/STANDARDS-REFERENCE.md +2 -1
- package/bundled/locales/zh-CN/docs/USAGE-MODES-COMPARISON.md +133 -132
- package/bundled/locales/zh-CN/docs/USER-MANUAL.md +11 -3
- package/bundled/locales/zh-CN/docs/WINDOWS-GUIDE.md +5 -2
- package/bundled/locales/zh-CN/docs/specs/system/memory-adoption-strategy.md +2 -0
- package/bundled/locales/zh-CN/docs/user/FAQ.md +2 -0
- package/bundled/locales/zh-CN/docs/user/GETTING-STARTED.md +2 -0
- package/bundled/locales/zh-CN/docs/user/GLOSSARY.md +2 -0
- package/bundled/locales/zh-CN/docs/user/README.md +4 -2
- package/bundled/locales/zh-CN/docs/user/TROUBLESHOOTING.md +2 -0
- package/bundled/locales/zh-CN/integrations/codex/AGENTS.md +136 -2
- package/bundled/locales/zh-CN/integrations/codex/README.md +62 -10
- package/bundled/locales/zh-CN/integrations/gemini-cli/GEMINI.md +59 -1
- package/bundled/locales/zh-CN/integrations/gemini-cli/README.md +9 -2
- package/bundled/locales/zh-CN/integrations/github-copilot/COPILOT-CHAT-REFERENCE.md +7 -1
- package/bundled/locales/zh-CN/integrations/github-copilot/README.md +8 -2
- package/bundled/locales/zh-CN/integrations/github-copilot/copilot-instructions.md +146 -12
- package/bundled/locales/zh-CN/integrations/github-copilot/skills-mapping.md +7 -1
- package/bundled/locales/zh-CN/integrations/google-antigravity/AGENTS.md +110 -3
- package/bundled/locales/zh-CN/integrations/google-antigravity/README.md +7 -1
- package/bundled/locales/zh-CN/integrations/opencode/AGENTS.md +140 -2
- package/bundled/locales/zh-CN/integrations/opencode/README.md +7 -1
- package/bundled/locales/zh-CN/integrations/opencode/skills-mapping.md +8 -2
- package/bundled/locales/zh-CN/integrations/openspec/AGENTS.md +46 -1
- package/bundled/locales/zh-CN/integrations/openspec/README.md +7 -1
- package/bundled/locales/zh-CN/integrations/spec-kit/AGENTS.md +20 -2
- package/bundled/locales/zh-CN/integrations/spec-kit/README.md +7 -1
- package/bundled/locales/zh-CN/options/changelog/auto-generated.md +2 -0
- package/bundled/locales/zh-CN/options/changelog/keep-a-changelog.md +2 -0
- package/bundled/locales/zh-CN/options/code-review/automated-review.md +2 -0
- package/bundled/locales/zh-CN/options/code-review/pair-programming.md +2 -0
- package/bundled/locales/zh-CN/options/commit-message/bilingual.md +139 -50
- package/bundled/locales/zh-CN/options/commit-message/english.md +159 -42
- package/bundled/locales/zh-CN/options/commit-message/traditional-chinese.md +156 -75
- package/bundled/locales/zh-CN/options/documentation/api-docs.md +3 -1
- package/bundled/locales/zh-CN/options/documentation/markdown-docs.md +2 -0
- package/bundled/locales/zh-CN/options/documentation/wiki-style.md +2 -0
- package/bundled/locales/zh-CN/options/git-workflow/gitflow.md +105 -77
- package/bundled/locales/zh-CN/options/git-workflow/github-flow.md +75 -57
- package/bundled/locales/zh-CN/options/git-workflow/merge-commit.md +155 -44
- package/bundled/locales/zh-CN/options/git-workflow/rebase-ff.md +168 -53
- package/bundled/locales/zh-CN/options/git-workflow/squash-merge.md +122 -37
- package/bundled/locales/zh-CN/options/git-workflow/trunk-based.md +108 -61
- package/bundled/locales/zh-CN/options/project-structure/dotnet.md +266 -47
- package/bundled/locales/zh-CN/options/project-structure/go.md +301 -43
- package/bundled/locales/zh-CN/options/project-structure/java.md +268 -48
- package/bundled/locales/zh-CN/options/project-structure/kotlin.md +2 -0
- package/bundled/locales/zh-CN/options/project-structure/nodejs.md +168 -51
- package/bundled/locales/zh-CN/options/project-structure/php.md +2 -0
- package/bundled/locales/zh-CN/options/project-structure/python.md +210 -52
- package/bundled/locales/zh-CN/options/project-structure/ruby.md +2 -0
- package/bundled/locales/zh-CN/options/project-structure/rust.md +2 -0
- package/bundled/locales/zh-CN/options/project-structure/swift.md +2 -0
- package/bundled/locales/zh-CN/options/testing/contract-testing.md +2 -0
- package/bundled/locales/zh-CN/options/testing/e2e-testing.md +227 -66
- package/bundled/locales/zh-CN/options/testing/industry-pyramid.md +2 -0
- package/bundled/locales/zh-CN/options/testing/integration-testing.md +185 -73
- package/bundled/locales/zh-CN/options/testing/istqb-framework.md +2 -0
- package/bundled/locales/zh-CN/options/testing/performance-testing.md +2 -0
- package/bundled/locales/zh-CN/options/testing/security-testing.md +2 -0
- package/bundled/locales/zh-CN/options/testing/system-testing.md +270 -96
- package/bundled/locales/zh-CN/options/testing/unit-testing.md +185 -71
- package/bundled/locales/zh-CN/skills/CONTRIBUTING.template.md +43 -42
- package/bundled/locales/zh-CN/skills/INTEGRATION-GUIDE.md +2 -1
- package/bundled/locales/zh-CN/skills/README.md +2 -1
- package/bundled/locales/zh-CN/skills/_shared/README.md +2 -1
- package/bundled/locales/zh-CN/skills/adr-assistant/guide.md +240 -4
- package/bundled/locales/zh-CN/skills/agents/README.md +180 -82
- package/bundled/locales/zh-CN/skills/agents/code-architect.md +3 -1
- package/bundled/locales/zh-CN/skills/agents/doc-writer.md +3 -1
- package/bundled/locales/zh-CN/skills/agents/reviewer.md +4 -2
- package/bundled/locales/zh-CN/skills/agents/spec-analyst.md +3 -1
- package/bundled/locales/zh-CN/skills/agents/test-specialist.md +3 -1
- package/bundled/locales/zh-CN/skills/ai-collaboration-standards/SKILL.md +91 -81
- package/bundled/locales/zh-CN/skills/ai-collaboration-standards/anti-hallucination.md +79 -59
- package/bundled/locales/zh-CN/skills/ai-collaboration-standards/certainty-labels.md +66 -40
- package/bundled/locales/zh-CN/skills/ai-friendly-architecture/SKILL.md +23 -36
- package/bundled/locales/zh-CN/skills/ai-instruction-standards/SKILL.md +217 -137
- package/bundled/locales/zh-CN/skills/api-design-assistant/SKILL.md +13 -2
- package/bundled/locales/zh-CN/skills/atdd-assistant/SKILL.md +16 -2
- package/bundled/locales/zh-CN/skills/atdd-assistant/acceptance-criteria-guide.md +2 -1
- package/bundled/locales/zh-CN/skills/atdd-assistant/atdd-workflow.md +98 -1
- package/bundled/locales/zh-CN/skills/atdd-assistant/guide.md +148 -132
- package/bundled/locales/zh-CN/skills/audit-assistant/SKILL.md +5 -2
- package/bundled/locales/zh-CN/skills/bdd-assistant/SKILL.md +16 -2
- package/bundled/locales/zh-CN/skills/bdd-assistant/bdd-workflow.md +2 -1
- package/bundled/locales/zh-CN/skills/bdd-assistant/gherkin-guide.md +2 -1
- package/bundled/locales/zh-CN/skills/bdd-assistant/guide.md +122 -121
- package/bundled/locales/zh-CN/skills/changelog-guide/SKILL.md +9 -2
- package/bundled/locales/zh-CN/skills/changelog-guide/guide.md +91 -88
- package/bundled/locales/zh-CN/skills/checkin-assistant/SKILL.md +12 -2
- package/bundled/locales/zh-CN/skills/checkin-assistant/guide.md +211 -210
- package/bundled/locales/zh-CN/skills/ci-cd-assistant/SKILL.md +14 -2
- package/bundled/locales/zh-CN/skills/code-review-assistant/SKILL.md +12 -2
- package/bundled/locales/zh-CN/skills/code-review-assistant/checkin-checklist.md +79 -78
- package/bundled/locales/zh-CN/skills/code-review-assistant/guide.md +119 -45
- package/bundled/locales/zh-CN/skills/code-review-assistant/review-checklist.md +89 -88
- package/bundled/locales/zh-CN/skills/commands/ac-coverage.md +43 -1
- package/bundled/locales/zh-CN/skills/commands/api-design.md +2 -1
- package/bundled/locales/zh-CN/skills/commands/atdd.md +71 -1
- package/bundled/locales/zh-CN/skills/commands/audit.md +2 -1
- package/bundled/locales/zh-CN/skills/commands/bdd.md +160 -62
- package/bundled/locales/zh-CN/skills/commands/changelog.md +36 -1
- package/bundled/locales/zh-CN/skills/commands/check.md +53 -1
- package/bundled/locales/zh-CN/skills/commands/checkin.md +45 -1
- package/bundled/locales/zh-CN/skills/commands/ci-cd.md +3 -2
- package/bundled/locales/zh-CN/skills/commands/code-review.md +41 -1
- package/bundled/locales/zh-CN/skills/commands/commit.md +56 -1
- package/bundled/locales/zh-CN/skills/commands/config.md +50 -1
- package/bundled/locales/zh-CN/skills/commands/coverage.md +43 -1
- package/bundled/locales/zh-CN/skills/commands/database.md +4 -3
- package/bundled/locales/zh-CN/skills/commands/derive-all.md +42 -1
- package/bundled/locales/zh-CN/skills/commands/derive-atdd.md +35 -1
- package/bundled/locales/zh-CN/skills/commands/derive-bdd.md +41 -1
- package/bundled/locales/zh-CN/skills/commands/derive-tdd.md +42 -1
- package/bundled/locales/zh-CN/skills/commands/derive.md +60 -4
- package/bundled/locales/zh-CN/skills/commands/dev-workflow.md +58 -8
- package/bundled/locales/zh-CN/skills/commands/discover.md +41 -1
- package/bundled/locales/zh-CN/skills/commands/docgen.md +37 -1
- package/bundled/locales/zh-CN/skills/commands/docs.md +136 -5
- package/bundled/locales/zh-CN/skills/commands/durable.md +4 -3
- package/bundled/locales/zh-CN/skills/commands/e2e.md +85 -1
- package/bundled/locales/zh-CN/skills/commands/guide.md +2 -1
- package/bundled/locales/zh-CN/skills/commands/incident.md +5 -4
- package/bundled/locales/zh-CN/skills/commands/init.md +57 -1
- package/bundled/locales/zh-CN/skills/commands/methodology.md +166 -77
- package/bundled/locales/zh-CN/skills/commands/metrics.md +3 -2
- package/bundled/locales/zh-CN/skills/commands/migrate.md +5 -4
- package/bundled/locales/zh-CN/skills/commands/observability.md +48 -3
- package/bundled/locales/zh-CN/skills/commands/pr.md +4 -3
- package/bundled/locales/zh-CN/skills/commands/refactor.md +76 -38
- package/bundled/locales/zh-CN/skills/commands/release.md +82 -1
- package/bundled/locales/zh-CN/skills/commands/requirement.md +40 -1
- package/bundled/locales/zh-CN/skills/commands/reverse-bdd.md +36 -1
- package/bundled/locales/zh-CN/skills/commands/reverse-sdd.md +44 -1
- package/bundled/locales/zh-CN/skills/commands/reverse-tdd.md +42 -1
- package/bundled/locales/zh-CN/skills/commands/reverse.md +43 -1
- package/bundled/locales/zh-CN/skills/commands/runbook.md +50 -3
- package/bundled/locales/zh-CN/skills/commands/scan.md +3 -2
- package/bundled/locales/zh-CN/skills/commands/sdd-retro.md +50 -1
- package/bundled/locales/zh-CN/skills/commands/sdd.md +182 -1
- package/bundled/locales/zh-CN/skills/commands/security.md +3 -2
- package/bundled/locales/zh-CN/skills/commands/slo.md +51 -3
- package/bundled/locales/zh-CN/skills/commands/tdd.md +74 -5
- package/bundled/locales/zh-CN/skills/commands/update.md +70 -8
- package/bundled/locales/zh-CN/skills/commit-standards/SKILL.md +4 -4
- package/bundled/locales/zh-CN/skills/commit-standards/conventional-commits.md +45 -44
- package/bundled/locales/zh-CN/skills/commit-standards/guide.md +172 -52
- package/bundled/locales/zh-CN/skills/commit-standards/language-options.md +50 -47
- package/bundled/locales/zh-CN/skills/contract-test-assistant/SKILL.md +2 -2
- package/bundled/locales/zh-CN/skills/contract-test-assistant/guide.md +76 -1
- package/bundled/locales/zh-CN/skills/database-assistant/SKILL.md +18 -5
- package/bundled/locales/zh-CN/skills/dev-methodology/SKILL.md +4 -2
- package/bundled/locales/zh-CN/skills/dev-methodology/create-methodology.md +2 -0
- package/bundled/locales/zh-CN/skills/dev-methodology/runtime.md +2 -0
- package/bundled/locales/zh-CN/skills/docs-generator/SKILL.md +16 -2
- package/bundled/locales/zh-CN/skills/docs-generator/guide.md +8 -7
- package/bundled/locales/zh-CN/skills/documentation-guide/SKILL.md +209 -184
- package/bundled/locales/zh-CN/skills/documentation-guide/documentation-structure.md +73 -72
- package/bundled/locales/zh-CN/skills/documentation-guide/readme-template.md +37 -36
- package/bundled/locales/zh-CN/skills/durable-execution-assistant/SKILL.md +28 -2
- package/bundled/locales/zh-CN/skills/e2e-assistant/SKILL.md +21 -6
- package/bundled/locales/zh-CN/skills/error-code-guide/SKILL.md +76 -95
- package/bundled/locales/zh-CN/skills/git-workflow-guide/SKILL.md +80 -87
- package/bundled/locales/zh-CN/skills/git-workflow-guide/branch-naming.md +44 -43
- package/bundled/locales/zh-CN/skills/git-workflow-guide/git-workflow.md +66 -65
- package/bundled/locales/zh-CN/skills/incident-response-assistant/SKILL.md +31 -13
- package/bundled/locales/zh-CN/skills/metrics-dashboard-assistant/SKILL.md +38 -2
- package/bundled/locales/zh-CN/skills/observability-assistant/SKILL.md +75 -1
- package/bundled/locales/zh-CN/skills/pr-automation-assistant/SKILL.md +32 -6
- package/bundled/locales/zh-CN/skills/project-discovery/SKILL.md +8 -2
- package/bundled/locales/zh-CN/skills/project-discovery/guide.md +158 -157
- package/bundled/locales/zh-CN/skills/project-structure-guide/SKILL.md +49 -46
- package/bundled/locales/zh-CN/skills/project-structure-guide/language-patterns.md +8 -7
- package/bundled/locales/zh-CN/skills/refactoring-assistant/SKILL.md +22 -2
- package/bundled/locales/zh-CN/skills/refactoring-assistant/guide.md +172 -171
- package/bundled/locales/zh-CN/skills/release-standards/SKILL.md +66 -23
- package/bundled/locales/zh-CN/skills/release-standards/changelog-format.md +42 -41
- package/bundled/locales/zh-CN/skills/release-standards/guide.md +51 -43
- package/bundled/locales/zh-CN/skills/release-standards/release-workflow.md +131 -95
- package/bundled/locales/zh-CN/skills/release-standards/semantic-versioning.md +62 -61
- package/bundled/locales/zh-CN/skills/requirement-assistant/SKILL.md +24 -15
- package/bundled/locales/zh-CN/skills/requirement-assistant/guide.md +88 -79
- package/bundled/locales/zh-CN/skills/requirement-assistant/requirement-checklist.md +128 -127
- package/bundled/locales/zh-CN/skills/requirement-assistant/requirement-writing.md +121 -120
- package/bundled/locales/zh-CN/skills/retrospective-assistant/guide.md +206 -2
- package/bundled/locales/zh-CN/skills/reverse-engineer/SKILL.md +2 -2
- package/bundled/locales/zh-CN/skills/reverse-engineer/bdd-extraction.md +2 -1
- package/bundled/locales/zh-CN/skills/reverse-engineer/guide.md +297 -173
- package/bundled/locales/zh-CN/skills/reverse-engineer/tdd-analysis.md +2 -1
- package/bundled/locales/zh-CN/skills/reverse-engineer/workflow.md +2 -1
- package/bundled/locales/zh-CN/skills/runbook-assistant/SKILL.md +9 -2
- package/bundled/locales/zh-CN/skills/security-assistant/SKILL.md +24 -6
- package/bundled/locales/zh-CN/skills/security-scan-assistant/SKILL.md +34 -10
- package/bundled/locales/zh-CN/skills/slo-assistant/SKILL.md +2 -1
- package/bundled/locales/zh-CN/skills/spec-derivation/SKILL.md +2 -2
- package/bundled/locales/zh-CN/skills/spec-driven-dev/guide.md +38 -6
- package/bundled/locales/zh-CN/skills/tdd-assistant/SKILL.md +16 -3
- package/bundled/locales/zh-CN/skills/tdd-assistant/guide.md +217 -156
- package/bundled/locales/zh-CN/skills/tdd-assistant/language-examples.md +727 -82
- package/bundled/locales/zh-CN/skills/tdd-assistant/tdd-workflow.md +396 -214
- package/bundled/locales/zh-CN/skills/test-coverage-assistant/SKILL.md +14 -5
- package/bundled/locales/zh-CN/skills/test-coverage-assistant/guide.md +25 -12
- package/bundled/locales/zh-CN/skills/testing-guide/testing-pyramid.md +99 -98
- package/bundled/locales/zh-CN/skills/testing-guide/testing-theory.md +3 -1
- package/bundled/locales/zh-CN/skills/tools/cline/README.md +2 -1
- package/bundled/locales/zh-CN/skills/tools/copilot/README.md +65 -18
- package/bundled/locales/zh-CN/skills/tools/copilot/copilot-instructions.md +2 -1
- package/bundled/locales/zh-CN/skills/tools/cursor/README.md +2 -1
- package/bundled/locales/zh-CN/skills/tools/windsurf/README.md +2 -1
- package/bundled/locales/zh-CN/skills/workflows/README.md +4 -2
- package/bundled/locales/zh-CN/templates/reverse-spec-template.md +50 -1
- package/bundled/locales/zh-TW/CHANGELOG.md +2323 -1128
- package/bundled/locales/zh-TW/CLAUDE.md +962 -76
- package/bundled/locales/zh-TW/README.md +3 -3
- package/bundled/locales/zh-TW/SECURITY.md +4 -3
- package/bundled/locales/zh-TW/STANDARDS-MAPPING.md +103 -6
- package/bundled/locales/zh-TW/adoption/ADOPTION-GUIDE.md +46 -93
- package/bundled/locales/zh-TW/adoption/DAILY-WORKFLOW-GUIDE.md +2 -1
- package/bundled/locales/zh-TW/adoption/STATIC-DYNAMIC-GUIDE.md +3 -1
- package/bundled/locales/zh-TW/adoption/checklists/enterprise.md +10 -9
- package/bundled/locales/zh-TW/adoption/checklists/minimal.md +6 -2
- package/bundled/locales/zh-TW/adoption/checklists/recommended.md +7 -4
- package/bundled/locales/zh-TW/ai/MAINTENANCE.md +34 -14
- package/bundled/locales/zh-TW/ai/options/commit-message/traditional-chinese.ai.yaml +48 -40
- package/bundled/locales/zh-TW/core/acceptance-criteria-traceability.md +56 -10
- package/bundled/locales/zh-TW/core/acceptance-test-driven-development.md +2 -1
- package/bundled/locales/zh-TW/core/accessibility-standards.md +895 -46
- package/bundled/locales/zh-TW/core/adr-standards.md +2 -1
- package/bundled/locales/zh-TW/core/agent-communication-protocol.md +2 -1
- package/bundled/locales/zh-TW/core/agent-dispatch.md +102 -33
- package/bundled/locales/zh-TW/core/ai-agreement-standards.md +58 -41
- package/bundled/locales/zh-TW/core/ai-command-behavior.md +2 -1
- package/bundled/locales/zh-TW/core/ai-friendly-architecture.md +306 -67
- package/bundled/locales/zh-TW/core/ai-instruction-standards.md +16 -13
- package/bundled/locales/zh-TW/core/ai-response-navigation.md +3 -3
- package/bundled/locales/zh-TW/core/alerting-standards.md +257 -35
- package/bundled/locales/zh-TW/core/anti-hallucination.md +169 -40
- package/bundled/locales/zh-TW/core/anti-sycophancy-prompting.md +2 -1
- package/bundled/locales/zh-TW/core/api-design-standards.md +2 -1
- package/bundled/locales/zh-TW/core/behavior-driven-development.md +3 -17
- package/bundled/locales/zh-TW/core/branch-completion.md +130 -34
- package/bundled/locales/zh-TW/core/capability-declaration.md +41 -79
- package/bundled/locales/zh-TW/core/change-batching-standards.md +2 -1
- package/bundled/locales/zh-TW/core/changelog-standards.md +14 -9
- package/bundled/locales/zh-TW/core/chaos-engineering-standards.md +138 -36
- package/bundled/locales/zh-TW/core/checkin-standards.md +84 -26
- package/bundled/locales/zh-TW/core/circuit-breaker.md +48 -87
- package/bundled/locales/zh-TW/core/code-review-checklist.md +19 -7
- package/bundled/locales/zh-TW/core/commit-message-guide.md +218 -87
- package/bundled/locales/zh-TW/core/containerization-standards.md +259 -57
- package/bundled/locales/zh-TW/core/context-aware-loading.md +121 -27
- package/bundled/locales/zh-TW/core/database-standards.md +2 -1
- package/bundled/locales/zh-TW/core/deprecation-standards.md +139 -37
- package/bundled/locales/zh-TW/core/design-document-standards.md +265 -55
- package/bundled/locales/zh-TW/core/developer-memory.md +102 -12
- package/bundled/locales/zh-TW/core/documentation-lifecycle.md +2 -1
- package/bundled/locales/zh-TW/core/documentation-structure.md +17 -8
- package/bundled/locales/zh-TW/core/dual-phase-output.md +28 -90
- package/bundled/locales/zh-TW/core/environment-standards.md +250 -72
- package/bundled/locales/zh-TW/core/error-code-standards.md +17 -6
- package/bundled/locales/zh-TW/core/estimation-standards.md +177 -44
- package/bundled/locales/zh-TW/core/execution-history.md +2 -1
- package/bundled/locales/zh-TW/core/failure-source-taxonomy.md +59 -117
- package/bundled/locales/zh-TW/core/feature-flag-standards.md +202 -57
- package/bundled/locales/zh-TW/core/forward-derivation-standards.md +592 -133
- package/bundled/locales/zh-TW/core/frontend-design-standards.md +120 -8
- package/bundled/locales/zh-TW/core/git-workflow.md +197 -37
- package/bundled/locales/zh-TW/core/git-worktree.md +79 -49
- package/bundled/locales/zh-TW/core/guides/anti-hallucination-guide.md +234 -487
- package/bundled/locales/zh-TW/core/guides/file-placement-guide.md +86 -2
- package/bundled/locales/zh-TW/core/guides/git-workflow-guide.md +411 -464
- package/bundled/locales/zh-TW/core/guides/performance-guide.md +2 -0
- package/bundled/locales/zh-TW/core/guides/refactoring-guide.md +237 -484
- package/bundled/locales/zh-TW/core/guides/security-guide.md +2 -0
- package/bundled/locales/zh-TW/core/health-check-standards.md +46 -104
- package/bundled/locales/zh-TW/core/immutability-first.md +45 -85
- package/bundled/locales/zh-TW/core/knowledge-graph-memory.md +2 -1
- package/bundled/locales/zh-TW/core/knowledge-transfer-standards.md +103 -40
- package/bundled/locales/zh-TW/core/mock-boundary.md +74 -6
- package/bundled/locales/zh-TW/core/observability-standards.md +284 -40
- package/bundled/locales/zh-TW/core/performance-standards.md +387 -86
- package/bundled/locales/zh-TW/core/pipeline-integration-standards.md +2 -1
- package/bundled/locales/zh-TW/core/postmortem-standards.md +367 -36
- package/bundled/locales/zh-TW/core/privacy-standards.md +153 -46
- package/bundled/locales/zh-TW/core/project-context-memory.md +210 -31
- package/bundled/locales/zh-TW/core/project-structure.md +240 -19
- package/bundled/locales/zh-TW/core/recovery-recipe-registry.md +54 -114
- package/bundled/locales/zh-TW/core/refactoring-standards.md +153 -48
- package/bundled/locales/zh-TW/core/requirement-engineering.md +8 -37
- package/bundled/locales/zh-TW/core/retrospective-standards.md +127 -7
- package/bundled/locales/zh-TW/core/retry-standards.md +41 -105
- package/bundled/locales/zh-TW/core/reverse-engineering-standards.md +5 -1
- package/bundled/locales/zh-TW/core/runbook-standards.md +296 -23
- package/bundled/locales/zh-TW/core/secret-management-standards.md +12 -4
- package/bundled/locales/zh-TW/core/security-decision.md +43 -84
- package/bundled/locales/zh-TW/core/security-standards.md +204 -25
- package/bundled/locales/zh-TW/core/self-review-protocol.md +2 -1
- package/bundled/locales/zh-TW/core/skill-standard-alignment-check.md +103 -69
- package/bundled/locales/zh-TW/core/slo-standards.md +301 -49
- package/bundled/locales/zh-TW/core/spec-driven-development.md +36 -7
- package/bundled/locales/zh-TW/core/standard-admission-criteria.md +22 -28
- package/bundled/locales/zh-TW/core/standard-lifecycle-management.md +40 -48
- package/bundled/locales/zh-TW/core/structured-task-definition.md +2 -1
- package/bundled/locales/zh-TW/core/supply-chain-security-standards.md +137 -10
- package/bundled/locales/zh-TW/core/systematic-debugging.md +94 -38
- package/bundled/locales/zh-TW/core/tech-debt-standards.md +170 -54
- package/bundled/locales/zh-TW/core/test-completeness-dimensions.md +101 -12
- package/bundled/locales/zh-TW/core/test-data-standards.md +245 -23
- package/bundled/locales/zh-TW/core/test-driven-development.md +4 -1
- package/bundled/locales/zh-TW/core/test-governance.md +92 -32
- package/bundled/locales/zh-TW/core/testing-standards.md +61 -14
- package/bundled/locales/zh-TW/core/timeout-standards.md +45 -85
- package/bundled/locales/zh-TW/core/token-budget.md +41 -112
- package/bundled/locales/zh-TW/core/translation-lifecycle-standards.md +28 -16
- package/bundled/locales/zh-TW/core/turn-completion-integrity.md +8 -6
- package/bundled/locales/zh-TW/core/verification-evidence.md +2 -1
- package/bundled/locales/zh-TW/core/versioning.md +6 -2
- package/bundled/locales/zh-TW/core/virtual-organization-standards.md +42 -36
- package/bundled/locales/zh-TW/core/workflow-enforcement.md +2 -1
- package/bundled/locales/zh-TW/core/workflow-state-protocol.md +2 -1
- package/bundled/locales/zh-TW/docs/CHEATSHEET.md +2 -1
- package/bundled/locales/zh-TW/docs/CLI-FLOW.md +2 -1
- package/bundled/locales/zh-TW/docs/CLI-INIT-OPTIONS.md +12 -3
- package/bundled/locales/zh-TW/docs/DEV-WORKFLOW-MAPPING.md +2 -1
- package/bundled/locales/zh-TW/docs/FEATURE-REFERENCE.md +8 -6
- package/bundled/locales/zh-TW/docs/STANDARDS-REFERENCE.md +2 -1
- package/bundled/locales/zh-TW/docs/USAGE-MODES-COMPARISON.md +2 -1
- package/bundled/locales/zh-TW/docs/USER-MANUAL.md +9 -1
- package/bundled/locales/zh-TW/docs/WINDOWS-GUIDE.md +4 -1
- package/bundled/locales/zh-TW/docs/specs/system/memory-adoption-strategy.md +2 -0
- package/bundled/locales/zh-TW/docs/user/FAQ.md +2 -0
- package/bundled/locales/zh-TW/docs/user/GETTING-STARTED.md +2 -0
- package/bundled/locales/zh-TW/docs/user/GLOSSARY.md +2 -0
- package/bundled/locales/zh-TW/docs/user/README.md +2 -0
- package/bundled/locales/zh-TW/docs/user/TROUBLESHOOTING.md +2 -0
- package/bundled/locales/zh-TW/integrations/claude-code/README.md +2 -1
- package/bundled/locales/zh-TW/integrations/codex/AGENTS.md +136 -2
- package/bundled/locales/zh-TW/integrations/codex/README.md +7 -1
- package/bundled/locales/zh-TW/integrations/gemini-cli/GEMINI.md +59 -1
- package/bundled/locales/zh-TW/integrations/gemini-cli/README.md +8 -1
- package/bundled/locales/zh-TW/integrations/github-copilot/COPILOT-CHAT-REFERENCE.md +7 -1
- package/bundled/locales/zh-TW/integrations/github-copilot/README.md +9 -3
- package/bundled/locales/zh-TW/integrations/github-copilot/copilot-instructions.md +146 -12
- package/bundled/locales/zh-TW/integrations/github-copilot/skills-mapping.md +7 -1
- package/bundled/locales/zh-TW/integrations/google-antigravity/AGENTS.md +110 -3
- package/bundled/locales/zh-TW/integrations/google-antigravity/README.md +7 -1
- package/bundled/locales/zh-TW/integrations/opencode/AGENTS.md +140 -2
- package/bundled/locales/zh-TW/integrations/opencode/README.md +7 -1
- package/bundled/locales/zh-TW/integrations/opencode/skills-mapping.md +8 -2
- package/bundled/locales/zh-TW/integrations/openspec/AGENTS.md +46 -1
- package/bundled/locales/zh-TW/integrations/openspec/README.md +7 -1
- package/bundled/locales/zh-TW/integrations/spec-kit/AGENTS.md +20 -2
- package/bundled/locales/zh-TW/integrations/spec-kit/README.md +7 -1
- package/bundled/locales/zh-TW/methodologies/guides/tdd-guide.md +584 -475
- package/bundled/locales/zh-TW/options/changelog/auto-generated.md +2 -0
- package/bundled/locales/zh-TW/options/changelog/keep-a-changelog.md +2 -0
- package/bundled/locales/zh-TW/options/code-review/automated-review.md +2 -0
- package/bundled/locales/zh-TW/options/code-review/pair-programming.md +2 -0
- package/bundled/locales/zh-TW/options/commit-message/bilingual.md +93 -5
- package/bundled/locales/zh-TW/options/commit-message/english.md +118 -1
- package/bundled/locales/zh-TW/options/commit-message/traditional-chinese.md +82 -1
- package/bundled/locales/zh-TW/options/documentation/api-docs.md +2 -0
- package/bundled/locales/zh-TW/options/documentation/markdown-docs.md +2 -0
- package/bundled/locales/zh-TW/options/documentation/wiki-style.md +2 -0
- package/bundled/locales/zh-TW/options/git-workflow/gitflow.md +99 -71
- package/bundled/locales/zh-TW/options/git-workflow/github-flow.md +68 -50
- package/bundled/locales/zh-TW/options/git-workflow/merge-commit.md +131 -20
- package/bundled/locales/zh-TW/options/git-workflow/rebase-ff.md +142 -27
- package/bundled/locales/zh-TW/options/git-workflow/squash-merge.md +100 -15
- package/bundled/locales/zh-TW/options/git-workflow/trunk-based.md +103 -56
- package/bundled/locales/zh-TW/options/project-structure/dotnet.md +233 -14
- package/bundled/locales/zh-TW/options/project-structure/go.md +270 -12
- package/bundled/locales/zh-TW/options/project-structure/java.md +235 -15
- package/bundled/locales/zh-TW/options/project-structure/kotlin.md +2 -0
- package/bundled/locales/zh-TW/options/project-structure/nodejs.md +136 -19
- package/bundled/locales/zh-TW/options/project-structure/php.md +2 -0
- package/bundled/locales/zh-TW/options/project-structure/python.md +177 -19
- package/bundled/locales/zh-TW/options/project-structure/ruby.md +2 -0
- package/bundled/locales/zh-TW/options/project-structure/rust.md +2 -0
- package/bundled/locales/zh-TW/options/project-structure/swift.md +2 -0
- package/bundled/locales/zh-TW/options/testing/contract-testing.md +2 -0
- package/bundled/locales/zh-TW/options/testing/e2e-testing.md +182 -21
- package/bundled/locales/zh-TW/options/testing/industry-pyramid.md +2 -0
- package/bundled/locales/zh-TW/options/testing/integration-testing.md +134 -22
- package/bundled/locales/zh-TW/options/testing/istqb-framework.md +2 -0
- package/bundled/locales/zh-TW/options/testing/performance-testing.md +2 -0
- package/bundled/locales/zh-TW/options/testing/security-testing.md +2 -0
- package/bundled/locales/zh-TW/options/testing/system-testing.md +175 -1
- package/bundled/locales/zh-TW/options/testing/unit-testing.md +123 -9
- package/bundled/locales/zh-TW/skills/CONTRIBUTING.template.md +3 -2
- package/bundled/locales/zh-TW/skills/INTEGRATION-GUIDE.md +2 -1
- package/bundled/locales/zh-TW/skills/README.md +2 -1
- package/bundled/locales/zh-TW/skills/_shared/README.md +2 -1
- package/bundled/locales/zh-TW/skills/ac-coverage/SKILL.md +15 -4
- package/bundled/locales/zh-TW/skills/adr-assistant/guide.md +123 -3
- package/bundled/locales/zh-TW/skills/agents/README.md +99 -1
- package/bundled/locales/zh-TW/skills/agents/code-architect.md +2 -0
- package/bundled/locales/zh-TW/skills/agents/doc-writer.md +2 -0
- package/bundled/locales/zh-TW/skills/agents/reviewer.md +3 -1
- package/bundled/locales/zh-TW/skills/agents/spec-analyst.md +2 -0
- package/bundled/locales/zh-TW/skills/agents/test-specialist.md +2 -0
- package/bundled/locales/zh-TW/skills/ai-collaboration-standards/SKILL.md +48 -37
- package/bundled/locales/zh-TW/skills/ai-collaboration-standards/anti-hallucination.md +22 -2
- package/bundled/locales/zh-TW/skills/ai-collaboration-standards/certainty-labels.md +29 -3
- package/bundled/locales/zh-TW/skills/ai-friendly-architecture/SKILL.md +23 -36
- package/bundled/locales/zh-TW/skills/ai-instruction-standards/SKILL.md +12 -36
- package/bundled/locales/zh-TW/skills/api-design-assistant/SKILL.md +21 -5
- package/bundled/locales/zh-TW/skills/atdd-assistant/SKILL.md +40 -15
- package/bundled/locales/zh-TW/skills/atdd-assistant/acceptance-criteria-guide.md +2 -1
- package/bundled/locales/zh-TW/skills/atdd-assistant/atdd-workflow.md +98 -1
- package/bundled/locales/zh-TW/skills/atdd-assistant/guide.md +24 -8
- package/bundled/locales/zh-TW/skills/audit-assistant/SKILL.md +8 -2
- package/bundled/locales/zh-TW/skills/bdd-assistant/SKILL.md +29 -6
- package/bundled/locales/zh-TW/skills/bdd-assistant/bdd-workflow.md +2 -1
- package/bundled/locales/zh-TW/skills/bdd-assistant/gherkin-guide.md +2 -1
- package/bundled/locales/zh-TW/skills/bdd-assistant/guide.md +9 -8
- package/bundled/locales/zh-TW/skills/changelog-guide/SKILL.md +12 -3
- package/bundled/locales/zh-TW/skills/changelog-guide/guide.md +11 -7
- package/bundled/locales/zh-TW/skills/checkin-assistant/SKILL.md +19 -3
- package/bundled/locales/zh-TW/skills/checkin-assistant/guide.md +5 -3
- package/bundled/locales/zh-TW/skills/ci-cd-assistant/SKILL.md +35 -16
- package/bundled/locales/zh-TW/skills/code-review-assistant/SKILL.md +19 -2
- package/bundled/locales/zh-TW/skills/code-review-assistant/checkin-checklist.md +2 -1
- package/bundled/locales/zh-TW/skills/code-review-assistant/guide.md +81 -6
- package/bundled/locales/zh-TW/skills/code-review-assistant/review-checklist.md +2 -1
- package/bundled/locales/zh-TW/skills/commands/ac-coverage.md +47 -2
- package/bundled/locales/zh-TW/skills/commands/api-design.md +3 -2
- package/bundled/locales/zh-TW/skills/commands/atdd.md +80 -10
- package/bundled/locales/zh-TW/skills/commands/audit.md +3 -2
- package/bundled/locales/zh-TW/skills/commands/bdd.md +114 -16
- package/bundled/locales/zh-TW/skills/commands/changelog.md +45 -9
- package/bundled/locales/zh-TW/skills/commands/check.md +74 -21
- package/bundled/locales/zh-TW/skills/commands/checkin.md +56 -11
- package/bundled/locales/zh-TW/skills/commands/ci-cd.md +2 -1
- package/bundled/locales/zh-TW/skills/commands/code-review.md +43 -2
- package/bundled/locales/zh-TW/skills/commands/commit.md +58 -4
- package/bundled/locales/zh-TW/skills/commands/config.md +52 -4
- package/bundled/locales/zh-TW/skills/commands/coverage.md +45 -4
- package/bundled/locales/zh-TW/skills/commands/database.md +3 -2
- package/bundled/locales/zh-TW/skills/commands/derive-all.md +44 -2
- package/bundled/locales/zh-TW/skills/commands/derive-atdd.md +37 -2
- package/bundled/locales/zh-TW/skills/commands/derive-bdd.md +44 -3
- package/bundled/locales/zh-TW/skills/commands/derive-tdd.md +45 -3
- package/bundled/locales/zh-TW/skills/commands/derive.md +62 -5
- package/bundled/locales/zh-TW/skills/commands/dev-workflow.md +60 -9
- package/bundled/locales/zh-TW/skills/commands/discover.md +43 -2
- package/bundled/locales/zh-TW/skills/commands/docgen.md +39 -2
- package/bundled/locales/zh-TW/skills/commands/docs.md +139 -7
- package/bundled/locales/zh-TW/skills/commands/durable.md +3 -2
- package/bundled/locales/zh-TW/skills/commands/e2e.md +86 -3
- package/bundled/locales/zh-TW/skills/commands/guide.md +4 -2
- package/bundled/locales/zh-TW/skills/commands/incident.md +3 -2
- package/bundled/locales/zh-TW/skills/commands/init.md +72 -15
- package/bundled/locales/zh-TW/skills/commands/methodology.md +117 -28
- package/bundled/locales/zh-TW/skills/commands/metrics.md +2 -1
- package/bundled/locales/zh-TW/skills/commands/migrate.md +2 -1
- package/bundled/locales/zh-TW/skills/commands/observability.md +45 -2
- package/bundled/locales/zh-TW/skills/commands/pr.md +2 -1
- package/bundled/locales/zh-TW/skills/commands/refactor.md +54 -13
- package/bundled/locales/zh-TW/skills/commands/release.md +83 -2
- package/bundled/locales/zh-TW/skills/commands/requirement.md +41 -2
- package/bundled/locales/zh-TW/skills/commands/reverse-bdd.md +37 -2
- package/bundled/locales/zh-TW/skills/commands/reverse-sdd.md +45 -2
- package/bundled/locales/zh-TW/skills/commands/reverse-tdd.md +43 -2
- package/bundled/locales/zh-TW/skills/commands/reverse.md +44 -2
- package/bundled/locales/zh-TW/skills/commands/runbook.md +47 -2
- package/bundled/locales/zh-TW/skills/commands/scan.md +3 -2
- package/bundled/locales/zh-TW/skills/commands/sdd-retro.md +52 -3
- package/bundled/locales/zh-TW/skills/commands/sdd.md +209 -28
- package/bundled/locales/zh-TW/skills/commands/security.md +3 -2
- package/bundled/locales/zh-TW/skills/commands/slo.md +48 -2
- package/bundled/locales/zh-TW/skills/commands/tdd.md +71 -2
- package/bundled/locales/zh-TW/skills/commands/update.md +64 -2
- package/bundled/locales/zh-TW/skills/commit-standards/SKILL.md +2 -2
- package/bundled/locales/zh-TW/skills/commit-standards/conventional-commits.md +2 -1
- package/bundled/locales/zh-TW/skills/commit-standards/guide.md +137 -17
- package/bundled/locales/zh-TW/skills/commit-standards/language-options.md +21 -18
- package/bundled/locales/zh-TW/skills/contract-test-assistant/SKILL.md +2 -2
- package/bundled/locales/zh-TW/skills/contract-test-assistant/guide.md +81 -1
- package/bundled/locales/zh-TW/skills/database-assistant/SKILL.md +21 -5
- package/bundled/locales/zh-TW/skills/deploy-assistant/SKILL.md +2 -1
- package/bundled/locales/zh-TW/skills/dev-methodology/SKILL.md +4 -1
- package/bundled/locales/zh-TW/skills/dev-methodology/create-methodology.md +2 -0
- package/bundled/locales/zh-TW/skills/dev-methodology/runtime.md +2 -0
- package/bundled/locales/zh-TW/skills/docs-generator/SKILL.md +19 -2
- package/bundled/locales/zh-TW/skills/docs-generator/guide.md +4 -3
- package/bundled/locales/zh-TW/skills/documentation-guide/SKILL.md +67 -42
- package/bundled/locales/zh-TW/skills/documentation-guide/documentation-structure.md +2 -1
- package/bundled/locales/zh-TW/skills/documentation-guide/readme-template.md +2 -1
- package/bundled/locales/zh-TW/skills/durable-execution-assistant/SKILL.md +32 -3
- package/bundled/locales/zh-TW/skills/e2e-assistant/SKILL.md +25 -7
- package/bundled/locales/zh-TW/skills/error-code-guide/SKILL.md +17 -34
- package/bundled/locales/zh-TW/skills/git-workflow-guide/SKILL.md +33 -38
- package/bundled/locales/zh-TW/skills/git-workflow-guide/branch-naming.md +2 -1
- package/bundled/locales/zh-TW/skills/git-workflow-guide/git-workflow.md +2 -1
- package/bundled/locales/zh-TW/skills/incident-response-assistant/SKILL.md +35 -14
- package/bundled/locales/zh-TW/skills/journey-test-assistant/SKILL.md +2 -14
- package/bundled/locales/zh-TW/skills/knowledge-graph/SKILL.md +6 -2
- package/bundled/locales/zh-TW/skills/metrics-dashboard-assistant/SKILL.md +42 -3
- package/bundled/locales/zh-TW/skills/observability-assistant/SKILL.md +85 -18
- package/bundled/locales/zh-TW/skills/pr-automation-assistant/SKILL.md +27 -3
- package/bundled/locales/zh-TW/skills/project-discovery/SKILL.md +11 -3
- package/bundled/locales/zh-TW/skills/project-discovery/guide.md +5 -3
- package/bundled/locales/zh-TW/skills/project-discovery/workflow.md +2 -1
- package/bundled/locales/zh-TW/skills/project-structure-guide/SKILL.md +19 -16
- package/bundled/locales/zh-TW/skills/project-structure-guide/language-patterns.md +2 -1
- package/bundled/locales/zh-TW/skills/refactoring-assistant/SKILL.md +26 -3
- package/bundled/locales/zh-TW/skills/refactoring-assistant/guide.md +4 -2
- package/bundled/locales/zh-TW/skills/release-standards/SKILL.md +91 -45
- package/bundled/locales/zh-TW/skills/release-standards/changelog-format.md +4 -3
- package/bundled/locales/zh-TW/skills/release-standards/guide.md +14 -5
- package/bundled/locales/zh-TW/skills/release-standards/release-workflow.md +5 -1
- package/bundled/locales/zh-TW/skills/release-standards/semantic-versioning.md +2 -1
- package/bundled/locales/zh-TW/skills/requirement-assistant/SKILL.md +15 -6
- package/bundled/locales/zh-TW/skills/requirement-assistant/guide.md +18 -8
- package/bundled/locales/zh-TW/skills/requirement-assistant/requirement-checklist.md +2 -1
- package/bundled/locales/zh-TW/skills/requirement-assistant/requirement-writing.md +2 -1
- package/bundled/locales/zh-TW/skills/retrospective-assistant/guide.md +200 -6
- package/bundled/locales/zh-TW/skills/reverse-engineer/bdd-extraction.md +2 -1
- package/bundled/locales/zh-TW/skills/reverse-engineer/guide.md +161 -36
- package/bundled/locales/zh-TW/skills/reverse-engineer/tdd-analysis.md +2 -1
- package/bundled/locales/zh-TW/skills/reverse-engineer/workflow.md +2 -1
- package/bundled/locales/zh-TW/skills/runbook-assistant/SKILL.md +9 -1
- package/bundled/locales/zh-TW/skills/security-assistant/SKILL.md +25 -5
- package/bundled/locales/zh-TW/skills/security-scan-assistant/SKILL.md +34 -8
- package/bundled/locales/zh-TW/skills/skill-builder/SKILL.md +3 -21
- package/bundled/locales/zh-TW/skills/slo-assistant/SKILL.md +3 -1
- package/bundled/locales/zh-TW/skills/spec-derivation/SKILL.md +2 -1
- package/bundled/locales/zh-TW/skills/spec-driven-dev/guide.md +35 -2
- package/bundled/locales/zh-TW/skills/sweep/SKILL.md +2 -1
- package/bundled/locales/zh-TW/skills/tdd-assistant/SKILL.md +10 -2
- package/bundled/locales/zh-TW/skills/tdd-assistant/guide.md +68 -9
- package/bundled/locales/zh-TW/skills/tdd-assistant/language-examples.md +693 -47
- package/bundled/locales/zh-TW/skills/tdd-assistant/tdd-workflow.md +183 -1
- package/bundled/locales/zh-TW/skills/test-coverage-assistant/SKILL.md +15 -5
- package/bundled/locales/zh-TW/skills/test-coverage-assistant/guide.md +26 -13
- package/bundled/locales/zh-TW/skills/testing-guide/testing-pyramid.md +2 -1
- package/bundled/locales/zh-TW/skills/testing-guide/testing-theory.md +3 -1
- package/bundled/locales/zh-TW/skills/tools/cline/README.md +2 -1
- package/bundled/locales/zh-TW/skills/tools/copilot/README.md +65 -18
- package/bundled/locales/zh-TW/skills/tools/copilot/copilot-instructions.md +2 -1
- package/bundled/locales/zh-TW/skills/tools/cursor/README.md +2 -1
- package/bundled/locales/zh-TW/skills/tools/windsurf/README.md +2 -1
- package/bundled/locales/zh-TW/skills/workflows/README.md +11 -9
- package/bundled/locales/zh-TW/templates/reverse-spec-template.md +50 -1
- package/bundled/skills/.claude-plugin/plugin.json +71 -0
- package/bundled/skills/commit-standards/SKILL.md +2 -2
- package/bundled/skills/commit-standards/guide.md +3 -2
- package/bundled/skills/commit-standards/language-options.md +19 -17
- package/package.json +2 -2
- package/src/commands/audit.js +28 -1
- package/src/commands/check.js +72 -3
- package/src/commands/compile.js +37 -4
- package/src/commands/config.js +49 -24
- package/src/commands/init.js +78 -30
- package/src/commands/open-work.js +6 -2
- package/src/commands/release-messages.js +228 -0
- package/src/commands/release.js +127 -68
- package/src/commands/run-intent.js +11 -0
- package/src/commands/spec.js +4 -2
- package/src/commands/update.js +227 -47
- package/src/compilers/claude-code-compiler.js +9 -1
- package/src/config/ai-agent-paths.js +14 -1
- package/src/core/installed-formats.js +15 -0
- package/src/core/open-work-config.js +20 -1
- package/src/core/project-config.js +55 -0
- package/src/i18n/messages.js +106 -2
- package/src/installers/hooks-installer.js +1 -1
- package/src/installers/manifest-installer.js +1 -1
- package/src/installers/skills-installer.js +1 -1
- package/src/installers/standards-installer.js +3 -1
- package/src/mcp/server.js +9 -3
- package/src/prompts/init.js +26 -22
- package/src/reconciler/actual-state-scanner.js +2 -8
- package/src/reconciler/backup-locations.js +5 -0
- package/src/reconciler/backup-manager.js +19 -11
- package/src/reconciler/desired-state-calculator.js +89 -57
- package/src/reconciler/plan-executor.js +101 -8
- package/src/reconciler/recorded-versions.js +49 -0
- package/src/reconciler/relative-path.js +23 -0
- package/src/uninstallers/hook-uninstaller.js +9 -1
- package/src/uninstallers/skills-uninstaller.js +22 -3
- package/src/utils/available-standards-report.js +25 -4
- package/src/utils/available-standards.js +13 -3
- package/src/utils/build-manifest.js +1 -1
- package/src/utils/commit-message-judge.js +60 -13
- package/src/utils/friction-detector.js +23 -11
- package/src/utils/git-hooks.js +106 -4
- package/src/utils/integration-generator.js +95 -67
- package/src/utils/legacy-hook-migration.js +121 -2
- package/src/utils/open-work-tracking.mjs +105 -16
- package/src/utils/sdd-header.js +16 -4
- package/src/utils/skills-installer.js +2 -1
- package/src/utils/spinner.js +14 -4
- package/src/utils/standard-validator.js +3 -2
- package/standards-registry.json +10 -8
- package/bundled/locales/zh-TW/core/guides/testing-guide.md +0 -2280
|
@@ -1,18 +1,28 @@
|
|
|
1
1
|
---
|
|
2
2
|
source: ../../../core/deprecation-standards.md
|
|
3
|
-
source_version: 1.
|
|
3
|
+
source_version: 1.1.0
|
|
4
4
|
translation_version: 1.0.0
|
|
5
|
-
last_synced: 2026-
|
|
6
|
-
|
|
5
|
+
last_synced: 2026-10-16
|
|
6
|
+
source_hash: 23dbc234e1e4
|
|
7
|
+
status: current
|
|
7
8
|
---
|
|
8
9
|
|
|
9
10
|
# 弃用与日落标准
|
|
10
11
|
|
|
11
|
-
>
|
|
12
|
+
> **语言**: [English](../../../core/deprecation-standards.md) | [繁體中文](../../zh-TW/core/deprecation-standards.md) | 简体中文
|
|
13
|
+
|
|
14
|
+
**版本**: 1.1.0
|
|
15
|
+
**最后更新**: 2026-06-24
|
|
16
|
+
**适用范围**: 所有软件项目
|
|
17
|
+
**范围**: universal
|
|
18
|
+
**行业标准**: RFC 8594 (Sunset Header), RFC 8288 (Web Linking)
|
|
19
|
+
**参考资料**: [RFC 8594](https://www.rfc-editor.org/rfc/rfc8594), [API Deprecation Best Practices](https://swagger.io/blog/api-strategy/api-versioning-deprecation/)
|
|
20
|
+
|
|
21
|
+
---
|
|
12
22
|
|
|
13
23
|
## 概述
|
|
14
24
|
|
|
15
|
-
|
|
25
|
+
本文件定义弃用全生命周期的管理标准——从 API 版本退役与功能日落到系统完全退役。结构化的弃用流程保护消费者、防止数据丢失,并确保基础设施整洁。
|
|
16
26
|
|
|
17
27
|
---
|
|
18
28
|
|
|
@@ -20,95 +30,200 @@ status: stale
|
|
|
20
30
|
|
|
21
31
|
### Sunset 时间线
|
|
22
32
|
|
|
33
|
+
退役 API 版本时,遵循以下 6 阶段时间线:
|
|
34
|
+
|
|
23
35
|
| 阶段 | 时间点 | 行动 |
|
|
24
36
|
|------|--------|------|
|
|
25
|
-
|
|
|
26
|
-
|
|
|
27
|
-
|
|
|
28
|
-
|
|
|
29
|
-
|
|
|
30
|
-
|
|
|
37
|
+
| **Announce** | T-6 个月 | 公布退役计划;发布 Sunset 日期;通知所有已知消费者 |
|
|
38
|
+
| **Deprecate** | T-3 个月 | 标记为 deprecated;在响应中添加 Deprecation 和 Sunset 请求头 |
|
|
39
|
+
| **Migrate** | T-3 到 T-1 个月 | 积极协助消费者迁移;提供迁移指南与工具 |
|
|
40
|
+
| **Warn** | T-1 个月 | 发送最终警告;在响应中加入倒计时信息 |
|
|
41
|
+
| **Sunset** | T | 停止响应请求;所有端点返回 410 Gone |
|
|
42
|
+
| **Archive** | T+1 个月 | 归档文档与数据;移除基础设施 |
|
|
31
43
|
|
|
32
44
|
### HTTP 弃用 Headers
|
|
33
45
|
|
|
46
|
+
当 API 版本进入 **Deprecate** 阶段时,所有响应必须包含:
|
|
47
|
+
|
|
34
48
|
```
|
|
35
49
|
Deprecation: true
|
|
36
50
|
Sunset: Sat, 31 Dec 2026 23:59:59 GMT
|
|
37
51
|
Link: <https://api.example.com/v3/docs>; rel="successor-version"
|
|
38
52
|
```
|
|
39
53
|
|
|
54
|
+
| Header | 用途 | 格式 |
|
|
55
|
+
|--------|------|------|
|
|
56
|
+
| `Deprecation` | 标明该 API 已弃用 | `true` (boolean) |
|
|
57
|
+
| `Sunset` | API 将被移除的日期 | RFC 7231 HTTP-date |
|
|
58
|
+
| `Link` | 指向后续版本的文档 | 带有 `rel="successor-version"` 的 URL |
|
|
59
|
+
|
|
40
60
|
### 版本并行期
|
|
41
61
|
|
|
42
|
-
|
|
43
|
-
|
|
62
|
+
当发布新版本时,旧版本必须至少维持到以下两者中较晚者:
|
|
63
|
+
|
|
64
|
+
- 新版本达到正式发布(GA)后 **6 个月**
|
|
44
65
|
- 最后一个活跃消费者完成迁移后 **3 个月**
|
|
45
66
|
|
|
67
|
+
这可确保消费者有充足的时间进行迁移而不会导致服务中断。
|
|
68
|
+
|
|
69
|
+
### 按 API 层级的最短弃用期
|
|
70
|
+
|
|
71
|
+
上述 6 阶段 Sunset 时间线展示了**公共 API 的默认节奏**(从 Announce 到 Sunset 大约有 6 个月的通知期)。*最短*弃用期随 API 的受众群体和关键程度而调整。适用以下层级最低要求与上述版本并行期两者中的**较长者**:
|
|
72
|
+
|
|
73
|
+
| API 层级 | 最短弃用期 |
|
|
74
|
+
|----------|------------|
|
|
75
|
+
| **Internal API** | 1 个次要版本 |
|
|
76
|
+
| **Partner API** | 2 个次要版本 + 3 个月 |
|
|
77
|
+
| **Public API** | 2 个次要版本 + 6 个月 |
|
|
78
|
+
| **Critical Infrastructure** | 最短 1 年 |
|
|
79
|
+
|
|
80
|
+
这些均为最低要求;SLA 或合同承诺可能要求更长的周期(参见[功能日落 → 影响分析](#impact-analysis))。至于什么*算作*触发弃用的破坏性变更(breaking change),以及 API 版本控制机制本身,均归入 [API 设计标准](api-design-standards.md#api-versioning-strategies)——本标准仅作为弃用时间线与这些通知期的唯一事实来源。
|
|
81
|
+
|
|
46
82
|
---
|
|
47
83
|
|
|
48
84
|
## 消费者通知策略
|
|
49
85
|
|
|
86
|
+
有效的弃用需要通过多种渠道触达消费者。使用至少 5 个通知渠道:
|
|
87
|
+
|
|
50
88
|
| 渠道 | 时机 | 内容 |
|
|
51
89
|
|------|------|------|
|
|
52
|
-
| **CHANGELOG** | 宣布阶段 | 退役计划、Sunset 日期、迁移指南链接 |
|
|
90
|
+
| **CHANGELOG / Release Notes** | 宣布阶段 | 退役计划、Sunset 日期、迁移指南链接 |
|
|
53
91
|
| **API Response Header** | 弃用阶段起 | Sunset header + successor-version 链接 |
|
|
54
92
|
| **Email / 通知** | 宣布 + 警告阶段 | 直接通知已知消费者 |
|
|
55
|
-
| **API 文档** | 宣布阶段起 | 明确标记为 deprecated |
|
|
93
|
+
| **API 文档** | 宣布阶段起 | 明确标记为 deprecated;提供新版本链接 |
|
|
56
94
|
| **Dashboard / 监控** | 弃用阶段起 | 追踪剩余消费者数量与流量 |
|
|
57
95
|
|
|
96
|
+
**最佳实践:**
|
|
97
|
+
- 在每次通知中均包含迁移指南链接
|
|
98
|
+
- 提供专用的迁移支持渠道(Slack、电子邮件别名)
|
|
99
|
+
- 追踪通知的送达率与确认率
|
|
100
|
+
|
|
58
101
|
---
|
|
59
102
|
|
|
60
103
|
## 功能日落
|
|
61
104
|
|
|
62
|
-
### 影响分析
|
|
105
|
+
### 影响分析
|
|
106
|
+
|
|
107
|
+
在移除某项功能之前,评估 5 个分析维度:
|
|
63
108
|
|
|
64
109
|
| 维度 | 关键问题 |
|
|
65
110
|
|------|---------|
|
|
66
|
-
|
|
|
67
|
-
|
|
|
68
|
-
|
|
|
69
|
-
|
|
|
70
|
-
|
|
|
111
|
+
| **Usage** | 过去 30 天有多少用户使用了此功能?趋势如何? |
|
|
112
|
+
| **Dependency** | 哪些其他功能、服务或集成依赖此功能? |
|
|
113
|
+
| **Data** | 此功能是否产生或管理独特数据?是否需要迁移或归档? |
|
|
114
|
+
| **Contract** | 是否存在与此功能绑定的 SLA 承诺、合同义务或合规要求? |
|
|
115
|
+
| **Alternative** | 是否有替代方案?用户是否知道如何迁移?替代方案功能是否完备? |
|
|
116
|
+
|
|
117
|
+
### 功能日落执行检查清单
|
|
118
|
+
|
|
119
|
+
影响分析完成并确认移除决策后,逐项核对:
|
|
120
|
+
|
|
121
|
+
- [ ] 通知受影响的用户(至少提前 30 天)
|
|
122
|
+
- [ ] 提供替代解决方案或迁移指南
|
|
123
|
+
- [ ] 移除功能代码(不留遗留死代码)
|
|
124
|
+
- [ ] 移除相关的 Feature Flags
|
|
125
|
+
- [ ] 迁移或归档相关数据
|
|
126
|
+
- [ ] 更新 API 文档和用户文档
|
|
127
|
+
- [ ] 设置重定向(旧 URL → 替代功能或说明页面)
|
|
128
|
+
- [ ] 更新 CHANGELOG
|
|
71
129
|
|
|
72
130
|
---
|
|
73
131
|
|
|
74
132
|
## 系统退役
|
|
75
133
|
|
|
76
|
-
|
|
134
|
+
### 退役流程
|
|
135
|
+
|
|
136
|
+
当退役整个系统或服务时,遵循以下 7 个阶段:
|
|
77
137
|
|
|
78
138
|
| 阶段 | 行动 | 验证 |
|
|
79
139
|
|------|------|------|
|
|
80
|
-
| 1.
|
|
81
|
-
| 2.
|
|
82
|
-
| 3.
|
|
83
|
-
| 4. DNS
|
|
84
|
-
| 5.
|
|
85
|
-
| 6.
|
|
86
|
-
| 7.
|
|
140
|
+
| **1. Dependency Analysis** | 识别所有上下游依赖 | 依赖图无未解节点 |
|
|
141
|
+
| **2. Consumer Migration** | 协助所有消费者迁移至替代服务 | 流量降至 0 |
|
|
142
|
+
| **3. Data Archival** | 依照合规与保留要求归档数据 | 归档完整性已验证 |
|
|
143
|
+
| **4. DNS/Redirect** | 旧端点返回 410 Gone 或重定向至替代服务 | 响应已验证正确 |
|
|
144
|
+
| **5. Infrastructure Cleanup** | 移除服务器、数据库、队列、存储 | 资源释放已确认 |
|
|
145
|
+
| **6. Monitoring Removal** | 移除告警、仪表板、Runbook | 无孤立告警残留 |
|
|
146
|
+
| **7. Documentation Archival** | 标记文档为已归档 | 文档索引已更新 |
|
|
147
|
+
|
|
148
|
+
### 数据归档策略
|
|
149
|
+
|
|
150
|
+
系统退役期间归档数据时,遵循以下保留规则:
|
|
151
|
+
|
|
152
|
+
| 数据类型 | 保留期限 | 归档方式 |
|
|
153
|
+
|----------|----------|----------|
|
|
154
|
+
| **User Data** | 依照隐私法规(GDPR:删除;其他:5–7 年) | 加密冷存储 |
|
|
155
|
+
| **Transaction Records** | 依照税务/审计要求(通常为 7 年) | 只读归档 |
|
|
156
|
+
| **Logs** | 1 年 | 压缩归档 |
|
|
157
|
+
| **Config/Code** | 永久(已在 Git 中) | Git 历史 |
|
|
158
|
+
|
|
159
|
+
**归档原则:**
|
|
160
|
+
- 在删除源数据前,使用校验和验证归档完整性
|
|
161
|
+
- 记录归档位置及访问程序
|
|
162
|
+
- 确保已归档数据仍可用于合规审计
|
|
87
163
|
|
|
88
164
|
---
|
|
89
165
|
|
|
90
166
|
## 退役指标
|
|
91
167
|
|
|
168
|
+
使用以下 4 项指标追踪弃用进度:
|
|
169
|
+
|
|
92
170
|
| 指标 | 定义 | 目标 |
|
|
93
171
|
|------|------|------|
|
|
94
|
-
|
|
|
95
|
-
|
|
|
96
|
-
|
|
|
97
|
-
|
|
|
172
|
+
| **Consumer Migration Rate** | 已迁移消费者 / 总消费者 | Sunset 时 100% |
|
|
173
|
+
| **Remaining Traffic** | 每日发往已弃用端点的请求数 | Sunset 时 0 |
|
|
174
|
+
| **Dependency Cleanup Rate** | 已清理依赖 / 总依赖 | Archive 时 100% |
|
|
175
|
+
| **Data Archival Completion** | 已归档数据集 / 需要归档的数据集总数 | Archive 时 100% |
|
|
176
|
+
|
|
177
|
+
**监控建议:**
|
|
178
|
+
- 弃用期间每周审查指标
|
|
179
|
+
- 若在中期消费者迁移率低于 50%,进行上报呈报
|
|
180
|
+
- 若剩余流量高于阈值,则阻断 Sunset
|
|
98
181
|
|
|
99
182
|
---
|
|
100
183
|
|
|
101
184
|
## 快速参考卡
|
|
102
185
|
|
|
103
|
-
### Sunset
|
|
186
|
+
### Sunset Timeline Summary
|
|
104
187
|
```
|
|
105
|
-
T-6
|
|
106
|
-
T-3
|
|
107
|
-
T-3
|
|
108
|
-
T-1
|
|
109
|
-
T
|
|
110
|
-
T+1
|
|
188
|
+
T-6 months → Announce (publish plan)
|
|
189
|
+
T-3 months → Deprecate (add headers)
|
|
190
|
+
T-3 to T-1 → Migrate (assist consumers)
|
|
191
|
+
T-1 month → Warn (final notice)
|
|
192
|
+
T → Sunset (410 Gone)
|
|
193
|
+
T+1 month → Archive (cleanup)
|
|
194
|
+
```
|
|
195
|
+
|
|
196
|
+
### Feature Removal Decision
|
|
111
197
|
```
|
|
198
|
+
Usage > 0 in 30 days? → Evaluate carefully
|
|
199
|
+
Has dependencies? → Map and migrate first
|
|
200
|
+
Has contractual obligation? → Legal review required
|
|
201
|
+
No alternative exists? → Build alternative first
|
|
202
|
+
```
|
|
203
|
+
|
|
204
|
+
---
|
|
205
|
+
|
|
206
|
+
## 参考资料
|
|
207
|
+
|
|
208
|
+
- [RFC 8594 — The Sunset HTTP Header Field](https://www.rfc-editor.org/rfc/rfc8594) — 传达 API 退役日期的标准
|
|
209
|
+
- [RFC 8288 — Web Linking](https://www.rfc-editor.org/rfc/rfc8288) — 包含 successor-version 的链接关系类型
|
|
210
|
+
- [API Versioning and Deprecation](https://swagger.io/blog/api-strategy/api-versioning-deprecation/) — API 生命周期管理的最佳实践
|
|
211
|
+
|
|
212
|
+
---
|
|
213
|
+
|
|
214
|
+
**相关标准:**
|
|
215
|
+
- [API 设计标准](api-design-standards.md) — API 设计与版本控制约定
|
|
216
|
+
- [Changelog 标准](changelog-standards.md) — 用于弃用公告的 CHANGELOG 格式
|
|
217
|
+
- [部署标准](deployment-standards.md) — 部署与基础设施管理
|
|
218
|
+
|
|
219
|
+
---
|
|
220
|
+
|
|
221
|
+
## 版本历史
|
|
222
|
+
|
|
223
|
+
| 版本 | 日期 | 变更 |
|
|
224
|
+
|------|------|------|
|
|
225
|
+
| 1.1.0 | 2026-06-24 | 新增:按 API 层级的最短弃用期——确立本标准作为弃用期的唯一事实来源,整合自 versioning.md 并与 Sunset 时间线和版本并行期保持一致(XSPEC-298 R8, UDS #126) |
|
|
226
|
+
| 1.0.0 | 2026-03-31 | 初始发布:API 弃用、功能日落、系统退役、退役指标 |
|
|
112
227
|
|
|
113
228
|
---
|
|
114
229
|
|
|
@@ -2,99 +2,309 @@
|
|
|
2
2
|
source: ../../../core/design-document-standards.md
|
|
3
3
|
source_version: 1.0.0
|
|
4
4
|
translation_version: 1.0.0
|
|
5
|
-
last_synced: 2026-
|
|
5
|
+
last_synced: 2026-10-16
|
|
6
|
+
source_hash: 984cb17b9a3f
|
|
6
7
|
status: current
|
|
7
8
|
---
|
|
8
9
|
|
|
9
10
|
# 设计文档标准
|
|
10
11
|
|
|
11
|
-
>
|
|
12
|
+
> **语言**: [English](../../../core/design-document-standards.md) | [繁體中文](../../zh-TW/core/design-document-standards.md) | 简体中文
|
|
13
|
+
|
|
14
|
+
**版本**: 1.0.0
|
|
15
|
+
**最后更新**: 2026-04-01
|
|
16
|
+
**适用性**: 所有软件项目
|
|
17
|
+
**范围**: 通用
|
|
18
|
+
**行业标准**: C4 Model, ADR (Architecture Decision Records), IEEE 1016
|
|
19
|
+
**参考资料**: [c4model.com](https://c4model.com/), [adr.github.io](https://adr.github.io/)
|
|
20
|
+
|
|
21
|
+
---
|
|
12
22
|
|
|
13
23
|
## 概述
|
|
14
24
|
|
|
15
|
-
|
|
25
|
+
本文档定义在软件项目中创建、维护和审查设计文档的标准。涵盖高层设计(HLD)与低层设计(LLD)结构、文档生命周期管理、使用 C4 Model 的架构图规范、设计决策记录以及系统性设计审查。
|
|
26
|
+
|
|
27
|
+
优秀的设计文档既是沟通工具,也是随系统共同演进的活文档。
|
|
28
|
+
|
|
29
|
+
---
|
|
16
30
|
|
|
17
31
|
## 高层设计(HLD)
|
|
18
32
|
|
|
19
|
-
|
|
33
|
+
高层设计文档记录系统级架构与战略决策。每份 HLD 必须包含以下 6 个章节:
|
|
34
|
+
|
|
35
|
+
### 1. 概述
|
|
36
|
+
|
|
37
|
+
**目的**: 定义问题陈述、项目目标和成功标准。
|
|
38
|
+
|
|
39
|
+
**内容指引**:
|
|
40
|
+
- 待解决的问题及其业务背景
|
|
41
|
+
- 范围内与范围外边界
|
|
42
|
+
- 关键成功指标
|
|
43
|
+
- 本文档的目标受众
|
|
44
|
+
|
|
45
|
+
### 2. 架构
|
|
46
|
+
|
|
47
|
+
**目的**: 描述系统架构决策与组件关系。
|
|
48
|
+
|
|
49
|
+
**内容指引**:
|
|
50
|
+
- 架构风格(微服务、单体、无服务器等)
|
|
51
|
+
- 关键组件及其职责
|
|
52
|
+
- 技术栈选型及理由
|
|
53
|
+
- 架构图(参见 C4 Model 章节)
|
|
54
|
+
|
|
55
|
+
### 3. 数据流
|
|
56
|
+
|
|
57
|
+
**目的**: 描述数据如何在系统中流动。
|
|
58
|
+
|
|
59
|
+
**内容指引**:
|
|
60
|
+
- 展示输入、转换和输出的数据流图
|
|
61
|
+
- 数据存储位置与持久化策略
|
|
62
|
+
- 数据同步机制(如适用)
|
|
63
|
+
- 数据量与吞吐量估算
|
|
64
|
+
|
|
65
|
+
### 4. API 接口
|
|
66
|
+
|
|
67
|
+
**目的**: 定义系统对外暴露的外部接口。
|
|
68
|
+
|
|
69
|
+
**内容指引**:
|
|
70
|
+
- API 端点或接口契约
|
|
71
|
+
- 认证与授权模型
|
|
72
|
+
- 版本控制策略
|
|
73
|
+
- 速率限制与配额策略
|
|
74
|
+
|
|
75
|
+
### 5. 非功能性需求
|
|
76
|
+
|
|
77
|
+
**目的**: 定义质量属性与约束条件。
|
|
20
78
|
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
79
|
+
**内容指引**:
|
|
80
|
+
- 性能目标(延迟、吞吐量)
|
|
81
|
+
- 可扩展性需求(水平、垂直)
|
|
82
|
+
- 可用性与可靠性目标(SLA/SLO)
|
|
83
|
+
- 安全需求与合规约束
|
|
84
|
+
|
|
85
|
+
### 6. 里程碑
|
|
86
|
+
|
|
87
|
+
**目的**: 定义实现时间线与交付阶段。
|
|
88
|
+
|
|
89
|
+
**内容指引**:
|
|
90
|
+
- 阶段拆分及可交付成果
|
|
91
|
+
- 各阶段之间的依赖关系
|
|
92
|
+
- 风险因素及缓解计划
|
|
93
|
+
- 每个里程碑的准入/准出(Go/no-go)标准
|
|
94
|
+
|
|
95
|
+
---
|
|
29
96
|
|
|
30
97
|
## 低层设计(LLD)
|
|
31
98
|
|
|
32
|
-
|
|
99
|
+
低层设计文档记录特定组件或模块的详细实现设计。每份 LLD 必须包含以下 5 个章节:
|
|
100
|
+
|
|
101
|
+
### 1. 组件设计
|
|
102
|
+
|
|
103
|
+
**目的**: 定义组件的内部结构。
|
|
104
|
+
|
|
105
|
+
**内容指引**:
|
|
106
|
+
- 类/模块层级与关系
|
|
107
|
+
- 接口定义与契约
|
|
108
|
+
- 所应用的软件设计模式及理由
|
|
109
|
+
- 依赖注入与配置
|
|
110
|
+
|
|
111
|
+
### 2. 数据模型
|
|
112
|
+
|
|
113
|
+
**目的**: 定义数据 Schema 与关系。
|
|
114
|
+
|
|
115
|
+
**内容指引**:
|
|
116
|
+
- 实体关系图
|
|
117
|
+
- 数据库 Schema 定义(表、列、类型、约束)
|
|
118
|
+
- 索引策略与查询优化考量
|
|
119
|
+
- 数据迁移策略(若修改现有 Schema)
|
|
120
|
+
|
|
121
|
+
### 3. 算法细节
|
|
122
|
+
|
|
123
|
+
**目的**: 描述关键算法及其复杂度。
|
|
124
|
+
|
|
125
|
+
**内容指引**:
|
|
126
|
+
- 算法伪代码或逐步描述
|
|
127
|
+
- 时间与空间复杂度分析(大 O 符号)
|
|
128
|
+
- 边界情况与边界条件
|
|
129
|
+
- 性能基准或预期
|
|
130
|
+
|
|
131
|
+
### 4. 错误处理
|
|
132
|
+
|
|
133
|
+
**目的**: 定义错误场景与恢复策略。
|
|
134
|
+
|
|
135
|
+
**内容指引**:
|
|
136
|
+
- 错误分类(瞬时、永久、部分)
|
|
137
|
+
- 重试策略与熔断器配置
|
|
138
|
+
- 降级行为与优雅降级
|
|
139
|
+
- 错误传播与面向用户的错误消息
|
|
140
|
+
|
|
141
|
+
### 5. 测试策略
|
|
142
|
+
|
|
143
|
+
**目的**: 定义组件的测试方法。
|
|
33
144
|
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
145
|
+
**内容指引**:
|
|
146
|
+
- 单元测试范围与关键测试用例
|
|
147
|
+
- 集成测试边界
|
|
148
|
+
- 外部依赖的 Mock/stub 策略
|
|
149
|
+
- 性能测试场景(如适用)
|
|
150
|
+
|
|
151
|
+
---
|
|
41
152
|
|
|
42
153
|
## 文档生命周期
|
|
43
154
|
|
|
155
|
+
设计文档必须遵循具有明确状态与流转的管理生命周期。
|
|
156
|
+
|
|
157
|
+
### 生命周期状态
|
|
158
|
+
|
|
44
159
|
```
|
|
45
160
|
Draft → In Review → Approved → Implemented → Archived
|
|
46
|
-
草稿 审查中 已批准 已实现 已归档
|
|
47
161
|
```
|
|
48
162
|
|
|
49
|
-
| 状态 | 定义 | 进入条件 | 退出条件 |
|
|
50
|
-
|
|
51
|
-
|
|
|
52
|
-
|
|
|
53
|
-
|
|
|
54
|
-
|
|
|
55
|
-
|
|
|
163
|
+
| 状态 | 定义 | 进入条件 | 退出条件 | 负责人 |
|
|
164
|
+
|-------|-----------|-----------------|----------------|-------------|
|
|
165
|
+
| **Draft** | 初始创建与迭代 | 作者开始撰写 | 作者提交审查 | 作者 |
|
|
166
|
+
| **In Review** | 处于同行审查与反馈中 | 提交审查 | 所有审查者批准或拒绝 | 审查者 |
|
|
167
|
+
| **Approved** | 接受并准备实现 | 审查通过 | 开始实现 | 技术主管 / 架构师 |
|
|
168
|
+
| **Implemented** | 设计已在代码中实现 | 代码符合设计 | 系统在生产环境中稳定运行 | 开发团队 |
|
|
169
|
+
| **Archived** | 不再活跃;保留供参考 | 系统退役或设计被取代 | 不适用 | 作者 / 技术主管 |
|
|
170
|
+
|
|
171
|
+
### 流转规则
|
|
172
|
+
|
|
173
|
+
- **Draft → In Review**: 作者确认文档已足够完整,可进行有意义的审查
|
|
174
|
+
- **In Review → Draft**: 审查者要求重大修改;作者修订
|
|
175
|
+
- **In Review → Approved**: 所有必需的审查者均已批准;不存在阻塞性问题
|
|
176
|
+
- **Approved → Implemented**: 实现符合已批准的设计
|
|
177
|
+
- **Implemented → Archived**: 系统退役或新设计取代此设计
|
|
178
|
+
- **任何状态 → Archived**: 文档被废弃(必须记录原因)
|
|
179
|
+
|
|
180
|
+
---
|
|
181
|
+
|
|
182
|
+
## 架构图
|
|
183
|
+
|
|
184
|
+
### C4 Model
|
|
56
185
|
|
|
57
|
-
|
|
186
|
+
设计文档必须采用 C4 Model 进行架构绘图,提供四个抽象层级。
|
|
58
187
|
|
|
59
|
-
| 层级 | 名称 | 范围 | 适用场景 |
|
|
60
|
-
|
|
61
|
-
| **L1** | **Context** | 系统与外部角色 |
|
|
62
|
-
| **L2** | **Container** | 应用程序与数据存储 | 技术概览、部署规划 |
|
|
63
|
-
| **L3** | **Component** | 内部组件 |
|
|
64
|
-
| **L4** | **Code** |
|
|
188
|
+
| 层级 | 名称 | 范围 | 适用场景 | 必需元素 |
|
|
189
|
+
|-------|------|-------|---------------------|-------------------|
|
|
190
|
+
| **L1** | **Context** | 系统与外部角色 | 利益相关方沟通、项目启动 | 系统边界、用户、外部系统、关系 |
|
|
191
|
+
| **L2** | **Container** | 应用程序与数据存储 | 技术概览、部署规划 | 应用程序、数据库、消息队列、协议 |
|
|
192
|
+
| **L3** | **Component** | 内部组件 | 开发者入职、详细设计 | 类/模块、接口、依赖关系 |
|
|
193
|
+
| **L4** | **Code** | 类/模块级别细节 | 复杂算法文档 | UML 类图、时序图 |
|
|
194
|
+
|
|
195
|
+
### 绘图指南
|
|
196
|
+
|
|
197
|
+
- **从 L1 开始**: 在深入细节之前,始终先从 Context 图开始
|
|
198
|
+
- **并非所有层级都是必需的**: 大多数项目使用 L1 和 L2;仅在复杂度需要时才使用 L3 和 L4
|
|
199
|
+
- **保持图表最新**: 当架构发生变化时及时更新图表
|
|
200
|
+
- **使用一致的表示法**: 遵循 C4 Model 关于形状、颜色和标签的惯例
|
|
201
|
+
|
|
202
|
+
---
|
|
65
203
|
|
|
66
204
|
## 设计决策记录
|
|
67
205
|
|
|
68
|
-
|
|
206
|
+
每个重要设计决策必须使用以下格式记录。
|
|
207
|
+
|
|
208
|
+
### 必需字段
|
|
209
|
+
|
|
210
|
+
| 字段 | 用途 | 内容 |
|
|
211
|
+
|-------|---------|---------|
|
|
212
|
+
| **Options** | 已考虑的可用替代方案 | 列出每个方案及其简要描述、优缺点 |
|
|
213
|
+
| **Decision** | 所选方案 | 说明选择了哪个方案 |
|
|
214
|
+
| **Rationale** | 决策背后的理由 | 解释为何选择该方案而非其他替代方案 |
|
|
215
|
+
|
|
216
|
+
### 补充字段
|
|
217
|
+
|
|
218
|
+
| 字段 | 用途 | 内容 |
|
|
219
|
+
|-------|---------|---------|
|
|
220
|
+
| **Constraints** | 影响决策的限制条件 | 技术、业务、监管或资源约束 |
|
|
221
|
+
| **Consequences** | 该决策的预期结果 | 正面与负面影响;所需的后续行动 |
|
|
222
|
+
| **Status** | 决策的当前状态 | Proposed、Accepted、Deprecated、Superseded |
|
|
223
|
+
| **Date** | 做出决策的时间 | ISO 8601 日期格式 |
|
|
224
|
+
|
|
225
|
+
### 示例格式
|
|
69
226
|
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
227
|
+
```markdown
|
|
228
|
+
## DD-001: Database Selection
|
|
229
|
+
|
|
230
|
+
**Status**: Accepted
|
|
231
|
+
**Date**: 2026-04-01
|
|
232
|
+
|
|
233
|
+
### Options
|
|
234
|
+
1. **PostgreSQL** — Mature RDBMS, strong JSON support. Pros: ecosystem, reliability. Cons: scaling complexity.
|
|
235
|
+
2. **MongoDB** — Document store, flexible schema. Pros: developer velocity. Cons: transaction limitations.
|
|
236
|
+
3. **DynamoDB** — Managed NoSQL. Pros: zero ops, auto-scaling. Cons: vendor lock-in, cost at scale.
|
|
237
|
+
|
|
238
|
+
### Decision
|
|
239
|
+
PostgreSQL
|
|
240
|
+
|
|
241
|
+
### Rationale
|
|
242
|
+
Our data model is relational with well-defined schemas. PostgreSQL provides ACID transactions required by our financial domain, strong JSON support for semi-structured data, and the team has extensive experience.
|
|
243
|
+
|
|
244
|
+
### Constraints
|
|
245
|
+
- Must support ACID transactions (regulatory requirement)
|
|
246
|
+
- Team has limited NoSQL experience
|
|
247
|
+
- Budget does not allow managed database services initially
|
|
248
|
+
|
|
249
|
+
### Consequences
|
|
250
|
+
- (+) Leverages existing team expertise
|
|
251
|
+
- (+) Strong ecosystem of tools and extensions
|
|
252
|
+
- (-) Requires manual scaling configuration for high traffic
|
|
253
|
+
- (-) Need to invest in connection pooling (PgBouncer)
|
|
254
|
+
```
|
|
255
|
+
|
|
256
|
+
---
|
|
77
257
|
|
|
78
258
|
## 设计审查清单
|
|
79
259
|
|
|
80
|
-
|
|
260
|
+
设计文档必须使用涵盖 5 个维度的以下清单进行审查。每个维度包含具体的检查项。
|
|
261
|
+
|
|
262
|
+
### 1. 正确性
|
|
81
263
|
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
264
|
+
- [ ] 设计满足所有声明的功能需求
|
|
265
|
+
- [ ] 边缘情况与边界条件得到妥善处理
|
|
266
|
+
- [ ] 数据流完整——无孤立的输入或输出
|
|
267
|
+
- [ ] 错误场景得到恰当处理
|
|
268
|
+
|
|
269
|
+
### 2. 可扩展性
|
|
270
|
+
|
|
271
|
+
- [ ] 设计支持预期的负载增长(10x、100x)
|
|
272
|
+
- [ ] 识别出瓶颈并制定了缓解计划
|
|
273
|
+
- [ ] 定义了水平扩展策略(如适用)
|
|
274
|
+
- [ ] 考虑了数据分区或分片策略
|
|
275
|
+
|
|
276
|
+
### 3. 安全性
|
|
277
|
+
|
|
278
|
+
- [ ] 认证与授权经过合理设计
|
|
279
|
+
- [ ] 明确了静态数据与传输中数据的加密
|
|
280
|
+
- [ ] 解决了输入验证与清理
|
|
281
|
+
- [ ] 满足合规性要求(GDPR、SOC2 等)
|
|
282
|
+
|
|
283
|
+
### 4. 可维护性
|
|
284
|
+
|
|
285
|
+
- [ ] 组件具有清晰的边界与职责
|
|
286
|
+
- [ ] 依赖项最小化且管理良好
|
|
287
|
+
- [ ] 配置已外部化(非硬编码)
|
|
288
|
+
- [ ] 内置了日志记录与调试支持
|
|
289
|
+
|
|
290
|
+
### 5. 可运维性
|
|
291
|
+
|
|
292
|
+
- [ ] 定义了部署策略(蓝绿、金丝雀等)
|
|
293
|
+
- [ ] 规划了监控与告警
|
|
294
|
+
- [ ] 明确了备份与灾难恢复程序
|
|
295
|
+
- [ ] 记录了回滚策略
|
|
89
296
|
|
|
90
297
|
---
|
|
91
298
|
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
-
|
|
299
|
+
## 参考文献
|
|
300
|
+
|
|
301
|
+
- Brown, S. (2018). *The C4 Model for Visualising Software Architecture*. [c4model.com](https://c4model.com/)
|
|
302
|
+
- Nygard, M. (2011). *Documenting Architecture Decisions*. [cognitect.com](https://www.cognitect.com/blog/2011/11/15/documenting-architecture-decisions)
|
|
303
|
+
- IEEE 1016-2009. *IEEE Standard for Information Technology — Systems Design — Software Design Descriptions*.
|
|
304
|
+
- Clements, P. et al. (2010). *Documenting Software Architectures: Views and Beyond*. Addison-Wesley.
|
|
95
305
|
|
|
96
306
|
---
|
|
97
307
|
|
|
98
308
|
## 许可
|
|
99
309
|
|
|
100
|
-
|
|
310
|
+
本文档以 [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/) 许可发布。
|