universal-dev-standards 6.14.0-beta.8 → 6.14.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/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/secret-management-standards.ai.yaml +12 -1
- package/bundled/core/commit-message-guide.md +22 -19
- package/bundled/core/secret-management-standards.md +13 -1
- package/bundled/extensions/locales/zh-tw.md +19 -19
- package/bundled/hooks/validate-commit-msg.mjs +52 -9
- package/bundled/locales/zh-CN/CHANGELOG.md +2312 -1102
- 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 +3 -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/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/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 +2291 -1110
- 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 +3 -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/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/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 +77 -7
- 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-split.js +2 -1
- package/src/commands/spec.js +11 -2
- package/src/commands/update.js +184 -30
- 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 +160 -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
|
@@ -2,17 +2,27 @@
|
|
|
2
2
|
source: ../../../core/deprecation-standards.md
|
|
3
3
|
source_version: 1.1.0
|
|
4
4
|
translation_version: 1.1.0
|
|
5
|
-
last_synced: 2026-
|
|
5
|
+
last_synced: 2026-10-16
|
|
6
|
+
source_hash: 23dbc234e1e4
|
|
6
7
|
status: current
|
|
7
8
|
---
|
|
8
9
|
|
|
9
10
|
# 棄用與日落標準
|
|
10
11
|
|
|
11
|
-
>
|
|
12
|
+
> **語言**: [English](../../../core/deprecation-standards.md) | 繁體中文
|
|
13
|
+
|
|
14
|
+
**版本**: 1.1.0
|
|
15
|
+
**最後更新**: 2026-06-24
|
|
16
|
+
**適用性**: 所有軟體專案
|
|
17
|
+
**範圍**: 通用
|
|
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,29 +30,42 @@ status: current
|
|
|
20
30
|
|
|
21
31
|
### Sunset 時間線
|
|
22
32
|
|
|
33
|
+
當退役 API 版本時,請遵循以下 6 階段時間線:
|
|
34
|
+
|
|
23
35
|
| 階段 | 時間點 | 行動 |
|
|
24
|
-
|
|
25
|
-
| **宣布** | T-6 個月 | 公布退役計畫;發布 Sunset
|
|
26
|
-
| **棄用** | T-3 個月 | 標記為 deprecated
|
|
27
|
-
| **遷移** | T-3 到 T-1 個月 |
|
|
28
|
-
| **警告** | T-1 個月 |
|
|
29
|
-
| **日落** | T |
|
|
36
|
+
|-------|-----------|---------|
|
|
37
|
+
| **宣布** | T-6 個月 | 公布退役計畫;發布 Sunset 日期;通知所有已知消費者 |
|
|
38
|
+
| **棄用** | T-3 個月 | 標記為 deprecated;在回應中加入 Deprecation 與 Sunset 標頭 |
|
|
39
|
+
| **遷移** | T-3 到 T-1 個月 | 積極協助消費者遷移;提供遷移指南與工具 |
|
|
40
|
+
| **警告** | T-1 個月 | 發送最終警告;在回應中加入倒數資訊 |
|
|
41
|
+
| **日落** | T | 停止提供服務;所有端點返回 410 Gone |
|
|
30
42
|
| **歸檔** | 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
|
+
| 標頭 | 目的 | 格式 |
|
|
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
|
+
|
|
46
69
|
### 依 API 分級的最短棄用期間
|
|
47
70
|
|
|
48
71
|
上方的 6 階段 Sunset 時間線呈現的是**公開 API 的預設節奏**(從宣布到日落約 6 個月通知期)。*最短*棄用期間會隨 API 的受眾與關鍵程度而調整。請取下表的分級最低值與上方版本平行期兩者中**較長者**:
|
|
@@ -54,60 +77,107 @@ Link: <https://api.example.com/v3/docs>; rel="successor-version"
|
|
|
54
77
|
| **公開 API** | 2 個 minor 版本 + 6 個月 |
|
|
55
78
|
| **關鍵基礎設施** | 最少 1 年 |
|
|
56
79
|
|
|
57
|
-
以上皆為最低值;SLA 或合約義務可能要求更長的期間(見[功能日落 → 影響分析](
|
|
80
|
+
以上皆為最低值;SLA 或合約義務可能要求更長的期間(見[功能日落 → 影響分析](#impact-analysis))。何謂觸發棄用的破壞性變更、以及 API 版本化機制本身,則歸[API 設計標準](api-design-standards.md#api-versioning-strategies)——本標準僅就棄用時間線與這些通知期間作為單一真實來源。
|
|
58
81
|
|
|
59
82
|
---
|
|
60
83
|
|
|
61
84
|
## 消費者通知策略
|
|
62
85
|
|
|
86
|
+
有效的棄用需要透過多個管道接觸消費者。請至少使用 5 個通知管道:
|
|
87
|
+
|
|
63
88
|
| 管道 | 時機 | 內容 |
|
|
64
|
-
|
|
65
|
-
| **CHANGELOG** | 宣布階段 | 退役計畫、Sunset 日期、遷移指南連結 |
|
|
66
|
-
| **API Response Header** | 棄用階段起 | Sunset
|
|
89
|
+
|---------|--------|---------|
|
|
90
|
+
| **CHANGELOG / Release Notes** | 宣布階段 | 退役計畫、Sunset 日期、遷移指南連結 |
|
|
91
|
+
| **API Response Header** | 棄用階段起 | Sunset 標頭 + successor-version 連結 |
|
|
67
92
|
| **Email / 通知** | 宣布 + 警告階段 | 直接通知已知消費者 |
|
|
68
|
-
| **API 文件** | 宣布階段起 | 明確標記為 deprecated |
|
|
93
|
+
| **API 文件** | 宣布階段起 | 明確標記為 deprecated;提供新版本連結 |
|
|
69
94
|
| **Dashboard / 監控** | 棄用階段起 | 追蹤剩餘消費者數量與流量 |
|
|
70
95
|
|
|
96
|
+
**最佳實踐:**
|
|
97
|
+
- 在每次通知中都附上遷移指南連結
|
|
98
|
+
- 提供專門的遷移支援管道(Slack、電子郵件別名)
|
|
99
|
+
- 追蹤通知送達率與確認率
|
|
100
|
+
|
|
71
101
|
---
|
|
72
102
|
|
|
73
103
|
## 功能日落
|
|
74
104
|
|
|
75
|
-
### 影響分析
|
|
105
|
+
### 影響分析
|
|
106
|
+
|
|
107
|
+
在移除功能之前,請評估 5 個分析維度:
|
|
76
108
|
|
|
77
109
|
| 維度 | 關鍵問題 |
|
|
78
|
-
|
|
79
|
-
| **使用量** | 過去 30
|
|
80
|
-
| **依賴** |
|
|
81
|
-
| **資料** |
|
|
82
|
-
| **合約** |
|
|
83
|
-
| **替代方案** |
|
|
110
|
+
|-----------|--------------|
|
|
111
|
+
| **使用量** | 過去 30 天內有多少使用者使用過此功能?趨勢為何? |
|
|
112
|
+
| **依賴** | 哪些其他功能、服務或整合依賴此功能? |
|
|
113
|
+
| **資料** | 此功能是否產生或管理獨特資料?是否需要遷移或歸檔? |
|
|
114
|
+
| **合約** | 是否有與此功能掛鉤的 SLA 承諾、合約義務或合規要求? |
|
|
115
|
+
| **替代方案** | 是否有替代品?使用者是否知道如何遷移?替代方案功能是否完整? |
|
|
116
|
+
|
|
117
|
+
### 功能日落執行檢查清單
|
|
118
|
+
|
|
119
|
+
在完成影響分析並確認移除決策後,請驗證每個項目:
|
|
120
|
+
|
|
121
|
+
- [ ] 通知受影響的使用者(至少提前 30 天)
|
|
122
|
+
- [ ] 提供替代方案或遷移指南
|
|
123
|
+
- [ ] 移除功能程式碼(不留死碼)
|
|
124
|
+
- [ ] 移除相關的 Feature Flags
|
|
125
|
+
- [ ] 遷移或歸檔相關資料
|
|
126
|
+
- [ ] 更新 API 文件與使用者文件
|
|
127
|
+
- [ ] 設定重導向(舊 URL → 替代功能或說明頁面)
|
|
128
|
+
- [ ] 更新 CHANGELOG
|
|
84
129
|
|
|
85
130
|
---
|
|
86
131
|
|
|
87
132
|
## 系統除役
|
|
88
133
|
|
|
89
|
-
|
|
134
|
+
### 除役流程
|
|
135
|
+
|
|
136
|
+
當退役整個系統或服務時,請遵循以下 7 個階段:
|
|
90
137
|
|
|
91
138
|
| 階段 | 行動 | 驗證 |
|
|
92
|
-
|
|
93
|
-
| 1.
|
|
94
|
-
| 2.
|
|
95
|
-
| 3.
|
|
96
|
-
| 4. DNS
|
|
97
|
-
| 5.
|
|
98
|
-
| 6.
|
|
99
|
-
| 7.
|
|
139
|
+
|-------|--------|-------------|
|
|
140
|
+
| **1. 依賴分析** | 識別所有上游與下游依賴 | 依賴圖無未解節點 |
|
|
141
|
+
| **2. 消費者遷移** | 協助所有消費者遷移至替代服務 | 流量降至 0 |
|
|
142
|
+
| **3. 資料歸檔** | 依合規與保留要求歸檔資料 | 歸檔完整性已驗證 |
|
|
143
|
+
| **4. DNS/重導向** | 舊端點返回 410 Gone 或重導向至替代服務 | 回應已驗證正確 |
|
|
144
|
+
| **5. 基礎設施清理** | 移除伺服器、資料庫、佇列、儲存空間 | 資源釋放已確認 |
|
|
145
|
+
| **6. 監控移除** | 移除告警、儀表板、Runbook | 無孤立告警殘留 |
|
|
146
|
+
| **7. 文件歸檔** | 將文件標記為已歸檔 | 文件索引已更新 |
|
|
147
|
+
|
|
148
|
+
### 資料歸檔策略
|
|
149
|
+
|
|
150
|
+
在系統退役期間歸檔資料時,請遵循以下保留規則:
|
|
151
|
+
|
|
152
|
+
| 資料類型 | 保留期間 | 歸檔方式 |
|
|
153
|
+
|-----------|-----------------|-----------------|
|
|
154
|
+
| **使用者資料** | 依隱私法規(GDPR:刪除;其他:5–7 年) | 加密冷儲存 |
|
|
155
|
+
| **交易紀錄** | 依稅務/稽核要求(通常為 7 年) | 唯讀封存 |
|
|
156
|
+
| **日誌** | 1 年 | 壓縮封存 |
|
|
157
|
+
| **設定/程式碼** | 永久(已在 Git 中) | Git 歷史紀錄 |
|
|
158
|
+
|
|
159
|
+
**歸檔原則:**
|
|
160
|
+
- 在刪除來源資料前,使用校驗和(checksum)驗證歸檔完整性
|
|
161
|
+
- 記錄歸檔位置與存取程序
|
|
162
|
+
- 確保歸檔資料仍可供合規稽核存取
|
|
100
163
|
|
|
101
164
|
---
|
|
102
165
|
|
|
103
166
|
## 退役指標
|
|
104
167
|
|
|
168
|
+
使用以下 4 個指標追蹤棄用進度:
|
|
169
|
+
|
|
105
170
|
| 指標 | 定義 | 目標 |
|
|
106
|
-
|
|
107
|
-
| **消費者遷移率** |
|
|
108
|
-
| **剩餘流量** |
|
|
109
|
-
| **依賴清理率** |
|
|
110
|
-
| **資料歸檔完成率** |
|
|
171
|
+
|--------|-----------|--------|
|
|
172
|
+
| **消費者遷移率** | 已遷移消費者 / 總消費者 | Sunset 時 100% |
|
|
173
|
+
| **剩餘流量** | 每日對已棄用端點的請求數 | Sunset 時 0 |
|
|
174
|
+
| **依賴清理率** | 已清理依賴 / 總依賴 | Archive 時 100% |
|
|
175
|
+
| **資料歸檔完成率** | 已歸檔資料集 / 需歸檔資料集總數 | Archive 時 100% |
|
|
176
|
+
|
|
177
|
+
**監控建議:**
|
|
178
|
+
- 在棄用期間每週檢視指標
|
|
179
|
+
- 若在期中時消費者遷移率低於 50%,應向上呈報升級
|
|
180
|
+
- 若剩餘流量高於門檻,則阻擋日落
|
|
111
181
|
|
|
112
182
|
---
|
|
113
183
|
|
|
@@ -123,6 +193,38 @@ T → 日落(410 Gone)
|
|
|
123
193
|
T+1 個月 → 歸檔(清理)
|
|
124
194
|
```
|
|
125
195
|
|
|
196
|
+
### 功能移除決策
|
|
197
|
+
```
|
|
198
|
+
30 天內使用量 > 0? → 仔細評估
|
|
199
|
+
有依賴? → 先盤點並遷移
|
|
200
|
+
有合約義務? → 需法律審查
|
|
201
|
+
無替代方案? → 先建立替代方案
|
|
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 Standards](changelog-standards.md) — 用於棄用公告的 CHANGELOG 格式
|
|
217
|
+
- [Deployment Standards](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 棄用、功能日落、系統除役、退役指標 |
|
|
227
|
+
|
|
126
228
|
---
|
|
127
229
|
|
|
128
230
|
## 授權
|
|
@@ -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) | 繁體中文
|
|
13
|
+
|
|
14
|
+
**版本**: 1.0.0
|
|
15
|
+
**最後更新**: 2026-04-01
|
|
16
|
+
**適用範圍**: 所有軟體專案
|
|
17
|
+
**範疇**: universal
|
|
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 應(SHALL)包含以下 6 個章節:
|
|
34
|
+
|
|
35
|
+
### 1. 概述
|
|
36
|
+
|
|
37
|
+
**目的**: 定義問題陳述、專案目標與成功標準。
|
|
38
|
+
|
|
39
|
+
**內容指引**:
|
|
40
|
+
- 正在解決的問題及其商業情境
|
|
41
|
+
- 範圍內(In-scope)與範圍外(out-of-scope)邊界
|
|
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 應(SHALL)包含以下 5 個章節:
|
|
100
|
+
|
|
101
|
+
### 1. 元件設計
|
|
102
|
+
|
|
103
|
+
**目的**: 定義元件的內部結構。
|
|
104
|
+
|
|
105
|
+
**內容指引**:
|
|
106
|
+
- 類別/模組階層與關係
|
|
107
|
+
- 介面定義與合約
|
|
108
|
+
- 套用的設計模式與理由
|
|
109
|
+
- 相依性注入與設定
|
|
110
|
+
|
|
111
|
+
### 2. 資料模型
|
|
112
|
+
|
|
113
|
+
**目的**: 定義資料 Schema 與關係。
|
|
114
|
+
|
|
115
|
+
**內容指引**:
|
|
116
|
+
- 實體關聯圖(Entity-relationship diagrams)
|
|
117
|
+
- 資料庫 Schema 定義(資料表、欄位、型別、條件約束)
|
|
118
|
+
- 索引策略與查詢最佳化考量
|
|
119
|
+
- 資料遷移策略(若修改現有 Schema)
|
|
120
|
+
|
|
121
|
+
### 3. 演算法細節
|
|
122
|
+
|
|
123
|
+
**目的**: 描述關鍵演算法與其複雜度。
|
|
124
|
+
|
|
125
|
+
**內容指引**:
|
|
126
|
+
- 演算法虛擬碼或逐步說明
|
|
127
|
+
- 時間與空間複雜度分析(Big-O 符號)
|
|
128
|
+
- 極端案例與邊界條件
|
|
129
|
+
- 效能基準或預期指標
|
|
130
|
+
|
|
131
|
+
### 4. 錯誤處理
|
|
132
|
+
|
|
133
|
+
**目的**: 定義錯誤情境與復原策略。
|
|
134
|
+
|
|
135
|
+
**內容指引**:
|
|
136
|
+
- 錯誤分類(暫態、永久、部分)
|
|
137
|
+
- 重試政策與斷路器(circuit breaker)設定
|
|
138
|
+
- 備援行為與溫和降級(graceful degradation)
|
|
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
|
+
設計文件應(SHALL)遵循具備明確狀態與轉換的管理生命週期。
|
|
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**: 所有必要的審查者皆已核准;無遺留的阻擋問題(blocking issues)
|
|
176
|
+
- **Approved → Implemented**: 實作符合已核准的設計
|
|
177
|
+
- **Implemented → Archived**: 系統退役或新設計取代此文件
|
|
178
|
+
- **任何狀態 → Archived**: 文件廢棄放棄(必須記錄原因)
|
|
179
|
+
|
|
180
|
+
---
|
|
181
|
+
|
|
182
|
+
## 架構圖
|
|
183
|
+
|
|
184
|
+
### C4 Model
|
|
56
185
|
|
|
57
|
-
|
|
186
|
+
設計文件應(SHALL)採用 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
|
+
- [ ] 設計支援預期的負載增長(10 倍、100 倍)
|
|
272
|
+
- [ ] 識別瓶頸並附帶緩解計畫
|
|
273
|
+
- [ ] 定義水平擴展策略(若適用)
|
|
274
|
+
- [ ] 考慮資料分割(partitioning)或分片(sharding)策略
|
|
275
|
+
|
|
276
|
+
### 3. 安全性
|
|
277
|
+
|
|
278
|
+
- [ ] 身分驗證與授權設計得當
|
|
279
|
+
- [ ] 規範待處理與傳輸中資料的加密
|
|
280
|
+
- [ ] 處理輸入驗證與清理(sanitization)
|
|
281
|
+
- [ ] 符合合規性需求(GDPR、SOC2 等)
|
|
282
|
+
|
|
283
|
+
### 4. 可維護性
|
|
284
|
+
|
|
285
|
+
- [ ] 元件具有明確的邊界與職責
|
|
286
|
+
- [ ] 相依性最小化且妥善管理
|
|
287
|
+
- [ ] 設定已外部化(非寫死)
|
|
288
|
+
- [ ] 內建記錄(logging)與除錯支援設計
|
|
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/) 授權。
|