universal-dev-standards 5.17.0 → 6.0.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 +13 -135
- package/bundled/ai/standards/acceptance-criteria-traceability.ai.yaml +13 -4
- package/bundled/ai/standards/accessibility-standards.ai.yaml +1 -1
- package/bundled/ai/standards/ai-response-navigation.ai.yaml +15 -2
- package/bundled/ai/standards/api-design-standards.ai.yaml +27 -4
- package/bundled/ai/standards/behavior-snapshot.ai.yaml +86 -9
- package/bundled/ai/standards/checkin-standards.ai.yaml +2 -2
- package/bundled/ai/standards/code-review.ai.yaml +2 -2
- package/bundled/ai/standards/context-aware-loading.ai.yaml +3 -3
- package/bundled/ai/standards/data-migration-testing.ai.yaml +79 -3
- package/bundled/ai/standards/deprecation-standards.ai.yaml +10 -2
- package/bundled/ai/standards/developer-memory.ai.yaml +4 -3
- package/bundled/ai/standards/flow-based-testing.ai.yaml +2 -2
- package/bundled/ai/standards/forward-derivation-standards.ai.yaml +26 -2
- package/bundled/ai/standards/full-coverage-testing.ai.yaml +34 -2
- package/bundled/ai/standards/git-worktree.ai.yaml +3 -3
- package/bundled/ai/standards/logging.ai.yaml +97 -3
- package/bundled/ai/standards/mock-boundary.ai.yaml +48 -2
- package/bundled/ai/standards/model-provenance.ai.yaml +297 -0
- package/bundled/ai/standards/model-selection.ai.yaml +11 -2
- package/bundled/ai/standards/observability-standards.ai.yaml +10 -0
- package/bundled/ai/standards/performance-standards.ai.yaml +46 -1
- package/bundled/ai/standards/pii-classification.ai.yaml +15 -1
- package/bundled/ai/standards/pipeline-security-gates.ai.yaml +10 -0
- package/bundled/ai/standards/privacy-standards.ai.yaml +2 -2
- package/bundled/ai/standards/project-context-memory.ai.yaml +2 -2
- package/bundled/ai/standards/refactoring-standards.ai.yaml +68 -3
- package/bundled/ai/standards/resource-cost-boundary.ai.yaml +279 -0
- package/bundled/ai/standards/reverse-engineering-standards.ai.yaml +55 -2
- package/bundled/ai/standards/security-testing.ai.yaml +13 -2
- package/bundled/ai/standards/skill-standard-alignment-check.ai.yaml +37 -2
- package/bundled/ai/standards/user-journey-testing.ai.yaml +107 -0
- package/bundled/ai/standards/verification-oracle.ai.yaml +278 -0
- package/bundled/ai/standards/versioning.ai.yaml +32 -38
- package/bundled/core/acceptance-criteria-traceability.md +15 -5
- package/bundled/core/accessibility-standards.md +8 -4
- package/bundled/core/ai-friendly-architecture.md +1 -1
- package/bundled/core/ai-response-navigation.md +31 -3
- package/bundled/core/anti-sycophancy-prompting.md +1 -1
- package/bundled/core/api-design-standards.md +92 -7
- package/bundled/core/audit-trail.md +119 -0
- package/bundled/core/behavior-snapshot.md +94 -7
- package/bundled/core/browser-compatibility-standards.md +15 -2
- package/bundled/core/checkin-standards.md +9 -2
- package/bundled/core/code-review-checklist.md +10 -2
- package/bundled/core/container-image-standards.md +97 -0
- package/bundled/core/context-aware-loading.md +2 -2
- package/bundled/core/cost-budget-test.md +1 -1
- package/bundled/core/cross-flow-regression.md +3 -2
- package/bundled/core/data-contract.md +104 -0
- package/bundled/core/data-migration-testing.md +90 -0
- package/bundled/core/data-pipeline.md +113 -0
- package/bundled/core/deprecation-standards.md +16 -2
- package/bundled/core/developer-memory.md +13 -8
- package/bundled/core/documentation-writing-standards.md +1 -1
- package/bundled/core/error-code-standards.md +4 -3
- package/bundled/core/flaky-test-management.md +1 -1
- package/bundled/core/flow-based-testing.md +3 -3
- package/bundled/core/forward-derivation-standards.md +33 -5
- package/bundled/core/full-coverage-testing.md +72 -0
- package/bundled/core/git-worktree.md +4 -4
- package/bundled/core/guides/performance-guide.md +1 -1
- package/bundled/core/guides/security-guide.md +1 -1
- package/bundled/core/health-check-standards.md +2 -2
- package/bundled/core/iac-design-principles.md +97 -0
- package/bundled/core/incident-response.md +119 -0
- package/bundled/core/license-compliance.md +2 -0
- package/bundled/core/logging-standards.md +78 -2
- package/bundled/core/mock-boundary.md +54 -2
- package/bundled/core/model-provenance.md +181 -0
- package/bundled/core/model-selection.md +27 -2
- package/bundled/core/packaging-standards.md +1 -0
- package/bundled/core/performance-standards.md +96 -2
- package/bundled/core/pii-classification.md +148 -0
- package/bundled/core/pipeline-security-gates.md +22 -2
- package/bundled/core/postmortem-standards.md +2 -0
- package/bundled/core/prd-standards.md +91 -0
- package/bundled/core/privacy-standards.md +14 -3
- package/bundled/core/product-metrics-standards.md +100 -0
- package/bundled/core/project-context-memory.md +8 -2
- package/bundled/core/prompt-regression.md +1 -1
- package/bundled/core/refactoring-standards.md +44 -3
- package/bundled/core/replay-test.md +1 -1
- package/bundled/core/resource-cost-boundary.md +180 -0
- package/bundled/core/reverse-engineering-standards.md +66 -2
- package/bundled/core/runbook.md +113 -0
- package/bundled/core/schema-evolution.md +105 -0
- package/bundled/core/secret-management-standards.md +110 -0
- package/bundled/core/security-testing.md +26 -2
- package/bundled/core/self-review-protocol.md +2 -2
- package/bundled/core/skill-standard-alignment-check.md +53 -0
- package/bundled/core/slo-sli.md +109 -0
- package/bundled/core/smoke-test.md +1 -1
- package/bundled/core/tech-debt-standards.md +1 -1
- package/bundled/core/test-data-standards.md +2 -2
- package/bundled/core/user-journey-testing.md +102 -0
- package/bundled/core/user-story-mapping.md +96 -0
- package/bundled/core/verification-oracle.md +167 -0
- package/bundled/core/versioning.md +133 -109
- package/bundled/locales/COVERAGE.md +84 -73
- package/bundled/locales/zh-CN/CHANGELOG.md +71 -6
- package/bundled/locales/zh-CN/CLAUDE.md +1 -1
- package/bundled/locales/zh-CN/README.md +22 -9
- package/bundled/locales/zh-CN/SECURITY.md +1 -1
- package/bundled/locales/zh-CN/adoption/DAILY-WORKFLOW-GUIDE.md +2 -2
- package/bundled/locales/zh-CN/core/acceptance-criteria-traceability.md +4 -6
- package/bundled/locales/zh-CN/core/accessibility-standards.md +1 -1
- package/bundled/locales/zh-CN/core/adversarial-test.md +226 -0
- package/bundled/locales/zh-CN/core/agent-behavior-discipline.md +187 -0
- package/bundled/locales/zh-CN/core/ai-response-navigation.md +32 -6
- package/bundled/locales/zh-CN/core/anti-sycophancy-prompting.md +1 -1
- package/bundled/locales/zh-CN/core/api-design-standards.md +1 -1
- package/bundled/locales/zh-CN/core/behavior-snapshot.md +335 -0
- package/bundled/locales/zh-CN/core/browser-compatibility-standards.md +229 -0
- package/bundled/locales/zh-CN/core/cd-deployment-strategies.md +135 -0
- package/bundled/locales/zh-CN/core/chaos-injection-tests.md +130 -0
- package/bundled/locales/zh-CN/core/checkin-standards.md +1 -1
- package/bundled/locales/zh-CN/core/code-review-checklist.md +1 -1
- package/bundled/locales/zh-CN/core/container-security.md +535 -0
- package/bundled/locales/zh-CN/core/context-aware-loading.md +1 -1
- package/bundled/locales/zh-CN/core/contract-testing-standards.md +191 -0
- package/bundled/locales/zh-CN/core/cost-budget-test.md +86 -0
- package/bundled/locales/zh-CN/core/cross-flow-regression.md +199 -0
- package/bundled/locales/zh-CN/core/data-migration-testing.md +217 -0
- package/bundled/locales/zh-CN/core/deployment-standards.md +328 -9
- package/bundled/locales/zh-CN/core/deprecation-standards.md +1 -1
- package/bundled/locales/zh-CN/core/developer-memory.md +2 -2
- package/bundled/locales/zh-CN/core/disaster-recovery-drill.md +87 -0
- package/bundled/locales/zh-CN/core/documentation-structure.md +1 -1
- package/bundled/locales/zh-CN/core/documentation-writing-standards.md +1 -1
- package/bundled/locales/zh-CN/core/error-code-standards.md +2 -2
- package/bundled/locales/zh-CN/core/feature-manifest-standard.md +222 -0
- package/bundled/locales/zh-CN/core/flaky-test-management.md +87 -0
- package/bundled/locales/zh-CN/core/flow-based-testing.md +284 -0
- package/bundled/locales/zh-CN/core/forward-derivation-standards.md +3 -4
- package/bundled/locales/zh-CN/core/full-coverage-testing.md +197 -0
- package/bundled/locales/zh-CN/core/git-worktree.md +1 -1
- package/bundled/locales/zh-CN/core/governance-layer.md +160 -0
- package/bundled/locales/zh-CN/core/guides/performance-guide.md +515 -0
- package/bundled/locales/zh-CN/core/guides/security-guide.md +494 -0
- package/bundled/locales/zh-CN/core/knowledge-graph-memory.md +128 -0
- package/bundled/locales/zh-CN/core/license-compliance.md +129 -0
- package/bundled/locales/zh-CN/core/llm-output-validation.md +192 -0
- package/bundled/locales/zh-CN/core/logging-standards.md +130 -8
- package/bundled/locales/zh-CN/core/mock-boundary.md +109 -0
- package/bundled/locales/zh-CN/core/model-selection.md +28 -5
- package/bundled/locales/zh-CN/core/mutation-testing.md +106 -0
- package/bundled/locales/zh-CN/core/no-cicd-deployment.md +219 -0
- package/bundled/locales/zh-CN/core/packaging-standards.md +76 -5
- package/bundled/locales/zh-CN/core/pipeline-security-gates.md +126 -0
- package/bundled/locales/zh-CN/core/policy-as-code-testing.md +203 -0
- package/bundled/locales/zh-CN/core/privacy-standards.md +1 -1
- package/bundled/locales/zh-CN/core/project-context-memory.md +1 -1
- package/bundled/locales/zh-CN/core/prompt-regression.md +88 -0
- package/bundled/locales/zh-CN/core/property-based-testing.md +87 -0
- package/bundled/locales/zh-CN/core/release-quality-manifest.md +207 -0
- package/bundled/locales/zh-CN/core/release-readiness-gate.md +193 -0
- package/bundled/locales/zh-CN/core/replay-test.md +102 -0
- package/bundled/locales/zh-CN/core/reverse-engineering-standards.md +46 -1
- package/bundled/locales/zh-CN/core/rollback-standards.md +120 -0
- package/bundled/locales/zh-CN/core/sast-advanced.md +309 -0
- package/bundled/locales/zh-CN/core/secure-op.md +328 -0
- package/bundled/locales/zh-CN/core/security-testing.md +96 -0
- package/bundled/locales/zh-CN/core/self-review-protocol.md +167 -0
- package/bundled/locales/zh-CN/core/server-ops-security.md +507 -0
- package/bundled/locales/zh-CN/core/smoke-test.md +79 -0
- package/bundled/locales/zh-CN/core/spec-driven-development.md +39 -3
- package/bundled/locales/zh-CN/core/supply-chain-attestation.md +131 -0
- package/bundled/locales/zh-CN/core/versioning.md +1 -1
- package/bundled/locales/zh-CN/docs/CHEATSHEET.md +31 -6
- package/bundled/locales/zh-CN/docs/FEATURE-REFERENCE.md +61 -34
- package/bundled/locales/zh-CN/docs/MIGRATION-v6.md +88 -0
- package/bundled/locales/zh-CN/docs/USAGE-MODES-COMPARISON.md +2 -2
- package/bundled/locales/zh-CN/docs/USER-MANUAL.md +14 -14
- package/bundled/locales/zh-CN/docs/specs/system/memory-adoption-strategy.md +105 -0
- package/bundled/locales/zh-CN/docs/user/FAQ.md +132 -0
- package/bundled/locales/zh-CN/docs/user/GETTING-STARTED.md +144 -0
- package/bundled/locales/zh-CN/docs/user/GLOSSARY.md +178 -0
- package/bundled/locales/zh-CN/docs/user/README.md +70 -0
- package/bundled/locales/zh-CN/docs/user/TROUBLESHOOTING.md +190 -0
- package/bundled/locales/zh-CN/integrations/github-copilot/COPILOT-CHAT-REFERENCE.md +1 -1
- package/bundled/locales/zh-CN/integrations/github-copilot/README.md +1 -1
- package/bundled/locales/zh-CN/integrations/github-copilot/skills-mapping.md +3 -3
- package/bundled/locales/zh-CN/integrations/opencode/skills-mapping.md +3 -3
- package/bundled/locales/zh-CN/methodologies/guides/sdd-guide.md +836 -0
- package/bundled/locales/zh-CN/options/changelog/auto-generated.md +166 -0
- package/bundled/locales/zh-CN/options/changelog/keep-a-changelog.md +140 -0
- package/bundled/locales/zh-CN/options/code-review/automated-review.md +214 -0
- package/bundled/locales/zh-CN/options/code-review/pair-programming.md +166 -0
- package/bundled/locales/zh-CN/options/code-review/pr-review.md +167 -0
- package/bundled/locales/zh-CN/options/documentation/api-docs.md +191 -0
- package/bundled/locales/zh-CN/options/documentation/markdown-docs.md +150 -0
- package/bundled/locales/zh-CN/options/documentation/wiki-style.md +131 -0
- package/bundled/locales/zh-CN/options/project-structure/kotlin.md +144 -0
- package/bundled/locales/zh-CN/options/project-structure/php.md +168 -0
- package/bundled/locales/zh-CN/options/project-structure/ruby.md +156 -0
- package/bundled/locales/zh-CN/options/project-structure/rust.md +136 -0
- package/bundled/locales/zh-CN/options/project-structure/swift.md +165 -0
- package/bundled/locales/zh-CN/options/testing/contract-testing.md +237 -0
- package/bundled/locales/zh-CN/options/testing/industry-pyramid.md +200 -0
- package/bundled/locales/zh-CN/options/testing/istqb-framework.md +144 -0
- package/bundled/locales/zh-CN/options/testing/performance-testing.md +251 -0
- package/bundled/locales/zh-CN/options/testing/security-testing.md +192 -0
- package/bundled/locales/zh-CN/skills/README.md +89 -126
- package/bundled/locales/zh-CN/skills/ac-coverage/SKILL.md +5 -7
- package/bundled/locales/zh-CN/skills/adr-assistant/SKILL.md +1 -1
- package/bundled/locales/zh-CN/skills/agents/code-architect.md +263 -0
- package/bundled/locales/zh-CN/skills/agents/doc-writer.md +410 -0
- package/bundled/locales/zh-CN/skills/agents/reviewer.md +357 -0
- package/bundled/locales/zh-CN/skills/agents/spec-analyst.md +410 -0
- package/bundled/locales/zh-CN/skills/agents/test-specialist.md +368 -0
- package/bundled/locales/zh-CN/skills/ai-collaboration-standards/SKILL.md +2 -2
- package/bundled/locales/zh-CN/skills/ai-friendly-architecture/SKILL.md +2 -2
- package/bundled/locales/zh-CN/skills/ai-instruction-standards/SKILL.md +1 -1
- package/bundled/locales/zh-CN/skills/atdd-assistant/acceptance-criteria-guide.md +1 -1
- package/bundled/locales/zh-CN/skills/atdd-assistant/atdd-workflow.md +3 -4
- package/bundled/locales/zh-CN/skills/audit-assistant/SKILL.md +2 -2
- package/bundled/locales/zh-CN/skills/bdd-assistant/guide.md +1 -2
- package/bundled/locales/zh-CN/skills/brainstorm-assistant/SKILL.md +109 -13
- package/bundled/locales/zh-CN/skills/brainstorm-assistant/guide.md +30 -8
- package/bundled/locales/zh-CN/skills/checkin-assistant/SKILL.md +1 -1
- package/bundled/locales/zh-CN/skills/ci-cd-assistant/SKILL.md +50 -0
- package/bundled/locales/zh-CN/skills/code-review-assistant/SKILL.md +5 -5
- package/bundled/locales/zh-CN/skills/commands/ac-coverage.md +1 -1
- package/bundled/locales/zh-CN/skills/commands/atdd.md +3 -3
- package/bundled/locales/zh-CN/skills/commands/bdd.md +2 -2
- package/bundled/locales/zh-CN/skills/commands/brainstorm.md +26 -17
- package/bundled/locales/zh-CN/skills/commands/{review.md → code-review.md} +4 -4
- package/bundled/locales/zh-CN/skills/commands/derive-all.md +1 -1
- package/bundled/locales/zh-CN/skills/commands/derive-atdd.md +1 -1
- package/bundled/locales/zh-CN/skills/commands/derive-bdd.md +2 -3
- package/bundled/locales/zh-CN/skills/commands/derive-tdd.md +1 -1
- package/bundled/locales/zh-CN/skills/commands/derive.md +1 -1
- package/bundled/locales/zh-CN/skills/commands/dev-workflow.md +2 -2
- package/bundled/locales/zh-CN/skills/commands/methodology.md +4 -4
- package/bundled/locales/zh-CN/skills/commands/pr.md +1 -1
- package/bundled/locales/zh-CN/skills/commands/tdd.md +1 -1
- package/bundled/locales/zh-CN/skills/commit-standards/SKILL.md +1 -1
- package/bundled/locales/zh-CN/skills/contract-test-assistant/SKILL.md +1 -1
- package/bundled/locales/zh-CN/skills/dev-methodology/SKILL.md +1 -1
- package/bundled/locales/zh-CN/skills/dev-methodology/create-methodology.md +456 -0
- package/bundled/locales/zh-CN/skills/dev-methodology/guide.md +6 -6
- package/bundled/locales/zh-CN/skills/dev-methodology/runtime.md +296 -0
- package/bundled/locales/zh-CN/skills/dev-workflow-guide/SKILL.md +5 -5
- package/bundled/locales/zh-CN/skills/docs-generator/SKILL.md +1 -1
- package/bundled/locales/zh-CN/skills/e2e-assistant/SKILL.md +1 -1
- package/bundled/locales/zh-CN/skills/incident-response-assistant/SKILL.md +2 -2
- package/bundled/locales/zh-CN/skills/journey-test-assistant/SKILL.md +1 -1
- package/bundled/locales/zh-CN/skills/logging-guide/SKILL.md +146 -142
- package/bundled/locales/zh-CN/skills/migration-assistant/SKILL.md +1 -1
- package/bundled/locales/zh-CN/skills/observability-assistant/guide.md +1 -1
- package/bundled/locales/zh-CN/skills/pr-automation-assistant/SKILL.md +1 -1
- package/bundled/locales/zh-CN/skills/project-discovery/guide.md +2 -2
- package/bundled/locales/zh-CN/skills/reverse-engineer/SKILL.md +1 -1
- package/bundled/locales/zh-CN/skills/runbook-assistant/guide.md +1 -1
- package/bundled/locales/zh-CN/skills/security-assistant/SKILL.md +1 -1
- package/bundled/locales/zh-CN/skills/skill-builder/SKILL.md +3 -3
- package/bundled/locales/zh-CN/skills/slo-assistant/guide.md +1 -1
- package/bundled/locales/zh-CN/skills/spec-derivation/SKILL.md +1 -1
- package/bundled/locales/zh-CN/skills/spec-derivation/guide.md +8 -9
- package/bundled/locales/zh-CN/skills/spec-driven-dev/SKILL.md +2 -2
- package/bundled/locales/zh-CN/skills/sweep/SKILL.md +1 -1
- package/bundled/locales/zh-CN/skills/tdd-assistant/SKILL.md +1 -1
- package/bundled/locales/zh-CN/skills/testing-guide/SKILL.md +2 -2
- package/bundled/locales/zh-CN/skills/testing-guide/testing-theory.md +2298 -0
- package/bundled/locales/zh-CN/skills/workflows/README.md +451 -0
- package/bundled/locales/zh-TW/CHANGELOG.md +71 -6
- package/bundled/locales/zh-TW/CLAUDE.md +1 -1
- package/bundled/locales/zh-TW/MAINTENANCE.md +25 -2
- package/bundled/locales/zh-TW/README.md +22 -9
- package/bundled/locales/zh-TW/SECURITY.md +1 -1
- package/bundled/locales/zh-TW/adoption/DAILY-WORKFLOW-GUIDE.md +2 -2
- package/bundled/locales/zh-TW/ai/standards/versioning.ai.yaml +8 -48
- package/bundled/locales/zh-TW/core/acceptance-criteria-traceability.md +4 -6
- package/bundled/locales/zh-TW/core/accessibility-standards.md +1 -1
- package/bundled/locales/zh-TW/core/adversarial-test.md +226 -0
- package/bundled/locales/zh-TW/core/agent-behavior-discipline.md +187 -0
- package/bundled/locales/zh-TW/core/ai-response-navigation.md +32 -6
- package/bundled/locales/zh-TW/core/anti-sycophancy-prompting.md +1 -1
- package/bundled/locales/zh-TW/core/api-design-standards.md +91 -9
- package/bundled/locales/zh-TW/core/audit-trail.md +110 -0
- package/bundled/locales/zh-TW/core/behavior-snapshot.md +335 -0
- package/bundled/locales/zh-TW/core/browser-compatibility-standards.md +1 -0
- package/bundled/locales/zh-TW/core/cd-deployment-strategies.md +135 -0
- package/bundled/locales/zh-TW/core/chaos-injection-tests.md +130 -0
- package/bundled/locales/zh-TW/core/checkin-standards.md +1 -1
- package/bundled/locales/zh-TW/core/code-review-checklist.md +1 -1
- package/bundled/locales/zh-TW/core/container-image-standards.md +93 -0
- package/bundled/locales/zh-TW/core/container-security.md +535 -0
- package/bundled/locales/zh-TW/core/cost-budget-test.md +86 -0
- package/bundled/locales/zh-TW/core/cross-flow-regression.md +1 -0
- package/bundled/locales/zh-TW/core/data-contract.md +101 -0
- package/bundled/locales/zh-TW/core/data-migration-testing.md +217 -0
- package/bundled/locales/zh-TW/core/data-pipeline.md +105 -0
- package/bundled/locales/zh-TW/core/deployment-standards.md +363 -25
- package/bundled/locales/zh-TW/core/deprecation-standards.md +17 -4
- package/bundled/locales/zh-TW/core/developer-memory.md +2 -2
- package/bundled/locales/zh-TW/core/disaster-recovery-drill.md +87 -0
- package/bundled/locales/zh-TW/core/documentation-writing-standards.md +1 -1
- package/bundled/locales/zh-TW/core/error-code-standards.md +2 -2
- package/bundled/locales/zh-TW/core/feature-manifest-standard.md +222 -0
- package/bundled/locales/zh-TW/core/flaky-test-management.md +87 -0
- package/bundled/locales/zh-TW/core/flow-based-testing.md +284 -0
- package/bundled/locales/zh-TW/core/forward-derivation-standards.md +3 -4
- package/bundled/locales/zh-TW/core/full-coverage-testing.md +250 -0
- package/bundled/locales/zh-TW/core/git-worktree.md +1 -1
- package/bundled/locales/zh-TW/core/guides/performance-guide.md +515 -0
- package/bundled/locales/zh-TW/core/guides/security-guide.md +494 -0
- package/bundled/locales/zh-TW/core/iac-design-principles.md +90 -0
- package/bundled/locales/zh-TW/core/incident-response.md +111 -0
- package/bundled/locales/zh-TW/core/license-compliance.md +129 -0
- package/bundled/locales/zh-TW/core/llm-output-validation.md +192 -0
- package/bundled/locales/zh-TW/core/logging-standards.md +208 -4
- package/bundled/locales/zh-TW/core/mock-boundary.md +161 -0
- package/bundled/locales/zh-TW/core/model-provenance.md +173 -0
- package/bundled/locales/zh-TW/core/model-selection.md +28 -5
- package/bundled/locales/zh-TW/core/mutation-testing.md +106 -0
- package/bundled/locales/zh-TW/core/no-cicd-deployment.md +219 -0
- package/bundled/locales/zh-TW/core/packaging-standards.md +76 -5
- package/bundled/locales/zh-TW/core/performance-standards.md +84 -5
- package/bundled/locales/zh-TW/core/pii-classification.md +102 -0
- package/bundled/locales/zh-TW/core/pipeline-security-gates.md +126 -0
- package/bundled/locales/zh-TW/core/policy-as-code-testing.md +203 -0
- package/bundled/locales/zh-TW/core/prd-standards.md +88 -0
- package/bundled/locales/zh-TW/core/privacy-standards.md +1 -1
- package/bundled/locales/zh-TW/core/product-metrics-standards.md +96 -0
- package/bundled/locales/zh-TW/core/project-context-memory.md +1 -1
- package/bundled/locales/zh-TW/core/prompt-regression.md +88 -0
- package/bundled/locales/zh-TW/core/property-based-testing.md +87 -0
- package/bundled/locales/zh-TW/core/refactoring-standards.md +43 -6
- package/bundled/locales/zh-TW/core/release-quality-manifest.md +207 -0
- package/bundled/locales/zh-TW/core/replay-test.md +102 -0
- package/bundled/locales/zh-TW/core/resource-cost-boundary.md +175 -0
- package/bundled/locales/zh-TW/core/reverse-engineering-standards.md +64 -5
- package/bundled/locales/zh-TW/core/rollback-standards.md +120 -0
- package/bundled/locales/zh-TW/core/runbook.md +110 -0
- package/bundled/locales/zh-TW/core/sast-advanced.md +309 -0
- package/bundled/locales/zh-TW/core/schema-evolution.md +98 -0
- package/bundled/locales/zh-TW/core/secret-management-standards.md +101 -0
- package/bundled/locales/zh-TW/core/secure-op.md +328 -0
- package/bundled/locales/zh-TW/core/security-testing.md +96 -0
- package/bundled/locales/zh-TW/core/self-review-protocol.md +2 -2
- package/bundled/locales/zh-TW/core/server-ops-security.md +507 -0
- package/bundled/locales/zh-TW/core/slo-sli.md +108 -0
- package/bundled/locales/zh-TW/core/smoke-test.md +79 -0
- package/bundled/locales/zh-TW/core/spec-driven-development.md +19 -11
- package/bundled/locales/zh-TW/core/supply-chain-attestation.md +131 -0
- package/bundled/locales/zh-TW/core/user-journey-testing.md +111 -0
- package/bundled/locales/zh-TW/core/user-story-mapping.md +94 -0
- package/bundled/locales/zh-TW/core/verification-oracle.md +159 -0
- package/bundled/locales/zh-TW/core/versioning.md +112 -112
- package/bundled/locales/zh-TW/docs/CHEATSHEET.md +31 -6
- package/bundled/locales/zh-TW/docs/DEV-WORKFLOW-MAPPING.md +6 -6
- package/bundled/locales/zh-TW/docs/FEATURE-REFERENCE.md +61 -34
- package/bundled/locales/zh-TW/docs/MIGRATION-v6.md +88 -0
- package/bundled/locales/zh-TW/docs/USAGE-MODES-COMPARISON.md +2 -2
- package/bundled/locales/zh-TW/docs/USER-MANUAL.md +14 -14
- package/bundled/locales/zh-TW/docs/specs/system/memory-adoption-strategy.md +105 -0
- package/bundled/locales/zh-TW/docs/user/FAQ.md +132 -0
- package/bundled/locales/zh-TW/docs/user/GETTING-STARTED.md +144 -0
- package/bundled/locales/zh-TW/docs/user/GLOSSARY.md +178 -0
- package/bundled/locales/zh-TW/docs/user/README.md +70 -0
- package/bundled/locales/zh-TW/docs/user/TROUBLESHOOTING.md +190 -0
- package/bundled/locales/zh-TW/integrations/github-copilot/COPILOT-CHAT-REFERENCE.md +1 -1
- package/bundled/locales/zh-TW/integrations/github-copilot/README.md +1 -1
- package/bundled/locales/zh-TW/integrations/github-copilot/skills-mapping.md +3 -3
- package/bundled/locales/zh-TW/integrations/opencode/skills-mapping.md +3 -3
- package/bundled/locales/zh-TW/methodologies/guides/sdd-guide.md +523 -26
- package/bundled/locales/zh-TW/options/changelog/auto-generated.md +166 -0
- package/bundled/locales/zh-TW/options/changelog/keep-a-changelog.md +140 -0
- package/bundled/locales/zh-TW/options/code-review/automated-review.md +214 -0
- package/bundled/locales/zh-TW/options/code-review/pair-programming.md +166 -0
- package/bundled/locales/zh-TW/options/code-review/pr-review.md +167 -0
- package/bundled/locales/zh-TW/options/documentation/api-docs.md +191 -0
- package/bundled/locales/zh-TW/options/documentation/markdown-docs.md +150 -0
- package/bundled/locales/zh-TW/options/documentation/wiki-style.md +131 -0
- package/bundled/locales/zh-TW/options/project-structure/kotlin.md +144 -0
- package/bundled/locales/zh-TW/options/project-structure/php.md +168 -0
- package/bundled/locales/zh-TW/options/project-structure/ruby.md +156 -0
- package/bundled/locales/zh-TW/options/project-structure/rust.md +136 -0
- package/bundled/locales/zh-TW/options/project-structure/swift.md +165 -0
- package/bundled/locales/zh-TW/options/testing/contract-testing.md +237 -0
- package/bundled/locales/zh-TW/options/testing/industry-pyramid.md +200 -0
- package/bundled/locales/zh-TW/options/testing/istqb-framework.md +144 -0
- package/bundled/locales/zh-TW/options/testing/performance-testing.md +251 -0
- package/bundled/locales/zh-TW/options/testing/security-testing.md +192 -0
- package/bundled/locales/zh-TW/skills/README.md +91 -128
- package/bundled/locales/zh-TW/skills/ac-coverage/SKILL.md +4 -6
- package/bundled/locales/zh-TW/skills/adr-assistant/SKILL.md +1 -1
- package/bundled/locales/zh-TW/skills/agents/code-architect.md +263 -0
- package/bundled/locales/zh-TW/skills/agents/doc-writer.md +410 -0
- package/bundled/locales/zh-TW/skills/agents/reviewer.md +357 -0
- package/bundled/locales/zh-TW/skills/agents/spec-analyst.md +410 -0
- package/bundled/locales/zh-TW/skills/agents/test-specialist.md +368 -0
- package/bundled/locales/zh-TW/skills/ai-collaboration-standards/SKILL.md +2 -2
- package/bundled/locales/zh-TW/skills/ai-friendly-architecture/SKILL.md +2 -2
- package/bundled/locales/zh-TW/skills/ai-instruction-standards/SKILL.md +1 -1
- package/bundled/locales/zh-TW/skills/atdd-assistant/SKILL.md +2 -0
- package/bundled/locales/zh-TW/skills/atdd-assistant/acceptance-criteria-guide.md +1 -1
- package/bundled/locales/zh-TW/skills/atdd-assistant/atdd-workflow.md +3 -4
- package/bundled/locales/zh-TW/skills/audit-assistant/SKILL.md +2 -2
- package/bundled/locales/zh-TW/skills/bdd-assistant/SKILL.md +2 -0
- package/bundled/locales/zh-TW/skills/bdd-assistant/guide.md +1 -2
- package/bundled/locales/zh-TW/skills/brainstorm-assistant/SKILL.md +110 -14
- package/bundled/locales/zh-TW/skills/brainstorm-assistant/guide.md +31 -7
- package/bundled/locales/zh-TW/skills/checkin-assistant/SKILL.md +3 -1
- package/bundled/locales/zh-TW/skills/ci-cd-assistant/SKILL.md +50 -0
- package/bundled/locales/zh-TW/skills/code-review-assistant/SKILL.md +7 -5
- package/bundled/locales/zh-TW/skills/commands/ac-coverage.md +1 -1
- package/bundled/locales/zh-TW/skills/commands/atdd.md +3 -3
- package/bundled/locales/zh-TW/skills/commands/bdd.md +2 -2
- package/bundled/locales/zh-TW/skills/commands/brainstorm.md +26 -17
- package/bundled/locales/zh-TW/skills/commands/{review.md → code-review.md} +5 -5
- package/bundled/locales/zh-TW/skills/commands/derive-all.md +1 -1
- package/bundled/locales/zh-TW/skills/commands/derive-atdd.md +1 -1
- package/bundled/locales/zh-TW/skills/commands/derive-bdd.md +2 -3
- package/bundled/locales/zh-TW/skills/commands/derive-tdd.md +1 -1
- package/bundled/locales/zh-TW/skills/commands/derive.md +1 -1
- package/bundled/locales/zh-TW/skills/commands/dev-workflow.md +2 -2
- package/bundled/locales/zh-TW/skills/commands/methodology.md +4 -4
- package/bundled/locales/zh-TW/skills/commands/pr.md +1 -1
- package/bundled/locales/zh-TW/skills/commands/tdd.md +1 -1
- package/bundled/locales/zh-TW/skills/commit-standards/SKILL.md +1 -1
- package/bundled/locales/zh-TW/skills/contract-test-assistant/SKILL.md +1 -1
- package/bundled/locales/zh-TW/skills/dev-methodology/create-methodology.md +456 -0
- package/bundled/locales/zh-TW/skills/dev-methodology/guide.md +5 -5
- package/bundled/locales/zh-TW/skills/dev-methodology/runtime.md +296 -0
- package/bundled/locales/zh-TW/skills/dev-workflow-guide/SKILL.md +5 -5
- package/bundled/locales/zh-TW/skills/docs-generator/SKILL.md +1 -1
- package/bundled/locales/zh-TW/skills/e2e-assistant/SKILL.md +1 -1
- package/bundled/locales/zh-TW/skills/incident-response-assistant/SKILL.md +2 -2
- package/bundled/locales/zh-TW/skills/logging-guide/SKILL.md +29 -27
- package/bundled/locales/zh-TW/skills/migration-assistant/SKILL.md +1 -1
- package/bundled/locales/zh-TW/skills/pr-automation-assistant/SKILL.md +3 -1
- package/bundled/locales/zh-TW/skills/project-discovery/guide.md +2 -2
- package/bundled/locales/zh-TW/skills/reverse-engineer/SKILL.md +1 -1
- package/bundled/locales/zh-TW/skills/security-assistant/SKILL.md +1 -1
- package/bundled/locales/zh-TW/skills/spec-derivation/guide.md +7 -8
- package/bundled/locales/zh-TW/skills/spec-driven-dev/SKILL.md +2 -2
- package/bundled/locales/zh-TW/skills/sweep/SKILL.md +1 -1
- package/bundled/locales/zh-TW/skills/tdd-assistant/SKILL.md +3 -1
- package/bundled/locales/zh-TW/skills/testing-guide/SKILL.md +2 -2
- package/bundled/locales/zh-TW/skills/testing-guide/testing-theory.md +2298 -0
- package/bundled/locales/zh-TW/skills/workflows/README.md +451 -0
- package/bundled/skills/README.md +1 -1
- package/bundled/skills/ac-coverage/SKILL.md +17 -7
- package/bundled/skills/adr-assistant/SKILL.md +1 -1
- package/bundled/skills/agents/code-architect.md +1 -1
- package/bundled/skills/agents/doc-writer.md +1 -1
- package/bundled/skills/agents/reviewer.md +2 -2
- package/bundled/skills/agents/spec-analyst.md +1 -1
- package/bundled/skills/agents/test-specialist.md +1 -1
- package/bundled/skills/ai-collaboration-standards/SKILL.md +2 -2
- package/bundled/skills/ai-friendly-architecture/SKILL.md +2 -2
- package/bundled/skills/ai-instruction-standards/SKILL.md +1 -1
- package/bundled/skills/atdd-assistant/SKILL.md +7 -0
- package/bundled/skills/atdd-assistant/acceptance-criteria-guide.md +1 -1
- package/bundled/skills/atdd-assistant/atdd-workflow.md +6 -8
- package/bundled/skills/audit-assistant/SKILL.md +2 -2
- package/bundled/skills/bdd-assistant/SKILL.md +7 -0
- package/bundled/skills/bdd-assistant/guide.md +1 -2
- package/bundled/skills/brainstorm-assistant/SKILL.md +133 -11
- package/bundled/skills/brainstorm-assistant/guide.md +33 -5
- package/bundled/skills/checkin-assistant/SKILL.md +8 -1
- package/bundled/skills/ci-cd-assistant/SKILL.md +57 -0
- package/bundled/skills/code-review-assistant/SKILL.md +15 -8
- package/bundled/skills/commands/COMMAND-FAMILY-OVERVIEW.md +2 -2
- package/bundled/skills/commands/COMMAND-INDEX.json +3 -3
- package/bundled/skills/commands/README.md +2 -2
- package/bundled/skills/commands/ac-coverage.md +1 -1
- package/bundled/skills/commands/atdd.md +2 -2
- package/bundled/skills/commands/bdd.md +2 -2
- package/bundled/skills/commands/brainstorm.md +25 -14
- package/bundled/skills/commands/{review.md → code-review.md} +6 -6
- package/bundled/skills/commands/derive-all.md +1 -1
- package/bundled/skills/commands/derive-atdd.md +1 -1
- package/bundled/skills/commands/derive-bdd.md +2 -3
- package/bundled/skills/commands/derive-tdd.md +1 -1
- package/bundled/skills/commands/derive.md +1 -1
- package/bundled/skills/commands/dev-workflow.md +1 -1
- package/bundled/skills/commands/journey-test.md +45 -0
- package/bundled/skills/commands/methodology.md +4 -4
- package/bundled/skills/commands/pr.md +1 -1
- package/bundled/skills/commands/skill-builder.md +42 -0
- package/bundled/skills/commands/tdd.md +1 -1
- package/bundled/skills/dev-methodology/create-methodology.md +1 -1
- package/bundled/skills/dev-methodology/guide.md +1 -1
- package/bundled/skills/dev-methodology/runtime.md +1 -1
- package/bundled/skills/dev-workflow-guide/SKILL.md +3 -3
- package/bundled/skills/dev-workflow-guide/workflow-phases.md +3 -3
- package/bundled/skills/docs-generator/SKILL.md +3 -3
- package/bundled/skills/incident-response-assistant/SKILL.md +2 -2
- package/bundled/skills/logging-guide/SKILL.md +38 -2
- package/bundled/skills/migration-assistant/SKILL.md +226 -0
- package/bundled/skills/observability-assistant/SKILL.md +74 -0
- package/bundled/skills/pr-automation-assistant/SKILL.md +5 -1
- package/bundled/skills/project-discovery/guide.md +2 -2
- package/bundled/skills/push/SKILL.md +1 -1
- package/bundled/skills/release-standards/SKILL.md +19 -5
- package/bundled/skills/security-assistant/SKILL.md +1 -1
- package/bundled/skills/skill-builder/SKILL.md +1 -1
- package/bundled/skills/spec-derivation/guide.md +3 -4
- package/bundled/skills/spec-driven-dev/SKILL.md +2 -2
- package/bundled/skills/sweep/SKILL.md +1 -1
- package/bundled/skills/tdd-assistant/SKILL.md +8 -1
- package/bundled/skills/testing-guide/SKILL.md +1 -1
- package/bundled/skills/testing-guide/testing-theory.md +1 -1
- package/bundled/skills/workflows/README.md +2 -2
- package/package.json +3 -3
- package/src/commands/audit.js +30 -9
- package/src/commands/config.js +33 -2
- package/src/commands/hitl.js +14 -1
- package/src/commands/init.js +110 -58
- package/src/commands/quickstart.js +1 -2
- package/src/commands/release.js +51 -6
- package/src/commands/run-intent.js +9 -0
- package/src/commands/spec-split.js +27 -2
- package/src/commands/update.js +22 -6
- package/src/config/ai-agent-paths.js +3 -1
- package/src/i18n/messages.js +3 -102
- package/src/missions/MissionManager.js +44 -12
- package/src/utils/build-manifest.js +35 -3
- package/src/utils/friction-detector.js +71 -22
- package/src/utils/health-checker.js +29 -2
- package/src/utils/transaction.js +111 -0
- package/src/utils/version-promote.js +16 -0
- package/standards-registry.json +58 -146
- package/bundled/ai/standards/agent-communication-protocol.ai.yaml +0 -42
- package/bundled/ai/standards/agent-dispatch.ai.yaml +0 -42
- package/bundled/ai/standards/branch-completion.ai.yaml +0 -44
- package/bundled/ai/standards/change-batching-standards.ai.yaml +0 -44
- package/bundled/ai/standards/execution-history.ai.yaml +0 -42
- package/bundled/ai/standards/pipeline-integration-standards.ai.yaml +0 -42
- package/bundled/ai/standards/workflow-enforcement.ai.yaml +0 -44
- package/bundled/ai/standards/workflow-state-protocol.ai.yaml +0 -43
- package/src/commands/flow.js +0 -260
- package/src/commands/start.js +0 -372
- package/src/commands/sweep.js +0 -151
- package/src/commands/workflow.js +0 -681
|
@@ -0,0 +1,113 @@
|
|
|
1
|
+
# Runbook Writing Standards
|
|
2
|
+
|
|
3
|
+
> **Version**: 1.0.0 | **Status**: Active | **Updated**: 2026-06-17
|
|
4
|
+
> **AI-optimized version**: `ai/standards/runbook.ai.yaml`
|
|
5
|
+
> **Spec**: XSPEC-063 (cross-project/specs/XSPEC-063-uds-sre-standards-pack.md)
|
|
6
|
+
|
|
7
|
+
**Scope**: universal
|
|
8
|
+
|
|
9
|
+
## Overview
|
|
10
|
+
|
|
11
|
+
This standard defines how operational **runbooks** are written, organized,
|
|
12
|
+
maintained, and tested. It covers required sections, writing principles
|
|
13
|
+
(reproducible, unambiguous steps), directory structure, review cadence, and drill
|
|
14
|
+
frequency. A well-written runbook reduces Mean Time To Repair (MTTR) by ensuring
|
|
15
|
+
any on-call engineer can execute recovery steps without requiring tribal
|
|
16
|
+
knowledge.
|
|
17
|
+
|
|
18
|
+
It is part of the **SRE/operations pack** (XSPEC-063) and is the executable
|
|
19
|
+
recovery member alongside `incident-response` (runbooks are executed during the
|
|
20
|
+
mitigate phase) and `slo-sli` (the error-budget policy is linked from the
|
|
21
|
+
runbook). It complements the existing `runbook-standards` Skill anchor; the
|
|
22
|
+
unique UDS contribution is an AI-executable runbook schema that a VibeOps
|
|
23
|
+
Governance Agent (DEC-042) can run directly.
|
|
24
|
+
|
|
25
|
+
> **Scope.** This standard defines *what a runbook must contain and how it is
|
|
26
|
+
> organized, reviewed, and drilled*. The runbook hosting tool (wiki, Git repo,
|
|
27
|
+
> PagerDuty) and the automation engine are adoption choices, not part of this
|
|
28
|
+
> standard.
|
|
29
|
+
|
|
30
|
+
## Requirements
|
|
31
|
+
|
|
32
|
+
| ID | Rule | Level |
|
|
33
|
+
|----|------|-------|
|
|
34
|
+
| REQ-001 | Required runbook sections (overview → post-actions) | MUST |
|
|
35
|
+
| REQ-002 | Reproducible and unambiguous steps (copy-pasteable + verification) | MUST |
|
|
36
|
+
| REQ-003 | Runbook naming and directory organization (typed dirs, kebab-case) | MUST |
|
|
37
|
+
| REQ-004 | Review and drill cadence (by type) | MUST |
|
|
38
|
+
| REQ-005 | Rollback and fallback steps (labeled, before escalation) | MUST |
|
|
39
|
+
| REQ-006 | Alert integration metadata (alert name, dashboard, query) | SHOULD |
|
|
40
|
+
|
|
41
|
+
### REQ-001 — Required Runbook Sections
|
|
42
|
+
|
|
43
|
+
Every runbook MUST include the following sections in order: (1) **Overview** —
|
|
44
|
+
alert name, severity, affected services, owner, last updated, last drilled date;
|
|
45
|
+
(2) **Symptoms** — observable indicators; (3) **Impact Assessment** — user-facing
|
|
46
|
+
effect and blast radius; (4) **Diagnostic Steps** — ordered steps with
|
|
47
|
+
copy-pasteable commands; (5) **Fix Steps** — ordered remediation with verification
|
|
48
|
+
for each step; (6) **Escalation** — specific contacts with role and availability;
|
|
49
|
+
(7) **Post-Actions** — follow-up tasks, tickets, postmortem triggers.
|
|
50
|
+
|
|
51
|
+
### REQ-002 — Reproducible and Unambiguous Steps
|
|
52
|
+
|
|
53
|
+
Each step in a runbook MUST be reproducible and unambiguous. Steps MUST use
|
|
54
|
+
copy-pasteable commands with no placeholders left undefined. Decision points MUST
|
|
55
|
+
include explicit branch conditions (if X then Y, else Z). Every fix step MUST
|
|
56
|
+
include a verification command confirming the fix worked before proceeding, and
|
|
57
|
+
the expected output MUST be shown.
|
|
58
|
+
|
|
59
|
+
### REQ-003 — Runbook Naming and Directory Organization
|
|
60
|
+
|
|
61
|
+
Runbooks MUST use kebab-case names that describe the problem, not the solution.
|
|
62
|
+
Files MUST be organized into typed directories: `alerts/` for alert-response
|
|
63
|
+
runbooks, `operations/` for standard ops, `emergency/` for major incident
|
|
64
|
+
procedures, and `troubleshooting/` for general investigation guides. Each runbook
|
|
65
|
+
file MUST declare its type in the front matter.
|
|
66
|
+
|
|
67
|
+
### REQ-004 — Review and Drill Cadence
|
|
68
|
+
|
|
69
|
+
Runbooks MUST be reviewed on schedule based on type: alert-response runbooks
|
|
70
|
+
quarterly, emergency procedures monthly, standard operation and troubleshooting
|
|
71
|
+
guides bi-annually, and change procedures after each use. Runbooks MUST be
|
|
72
|
+
drilled: P1 runbooks monthly, P2 quarterly, emergency procedures quarterly. Drill
|
|
73
|
+
records MUST be appended to the runbook or linked from it.
|
|
74
|
+
|
|
75
|
+
### REQ-005 — Rollback and Fallback Steps
|
|
76
|
+
|
|
77
|
+
Any runbook describing a change or fix MUST include a clearly labeled rollback
|
|
78
|
+
section describing how to undo the change if the fix fails or causes additional
|
|
79
|
+
issues. The rollback section MUST appear before the escalation section and include
|
|
80
|
+
its own verification steps.
|
|
81
|
+
|
|
82
|
+
### REQ-006 — Alert Integration Metadata
|
|
83
|
+
|
|
84
|
+
Alert-response runbooks SHOULD include a metadata block linking the runbook to
|
|
85
|
+
specific alert rules. This enables automatic runbook linking in alerting tools
|
|
86
|
+
(PagerDuty, Alertmanager). Metadata MUST include the alert name, dashboard URL,
|
|
87
|
+
and the Prometheus/logging query used to investigate.
|
|
88
|
+
|
|
89
|
+
## Integration with Existing Standards
|
|
90
|
+
|
|
91
|
+
- **`runbook-standards`** — the existing Skill-anchor standard; `runbook` provides
|
|
92
|
+
the AI-executable schema and the section/drill requirements behind it.
|
|
93
|
+
- **`incident-response`** — runbooks are executed during the incident mitigate
|
|
94
|
+
phase; SEV runbooks are drilled per the cadence here.
|
|
95
|
+
- **`slo-sli`** — the error-budget policy MUST be linked from the service runbook.
|
|
96
|
+
- **`rollback-standards`** — REQ-005 rollback steps align with the rollback
|
|
97
|
+
standard's undo procedures.
|
|
98
|
+
- **`alerting-standards`** — REQ-006 metadata links alert rules to their runbook.
|
|
99
|
+
- **`execution-history`** — when a runbook is marked `automation_level: automated`,
|
|
100
|
+
the Governance Agent's execution results are recorded as execution history.
|
|
101
|
+
|
|
102
|
+
## Related Specs
|
|
103
|
+
|
|
104
|
+
- XSPEC-063 — UDS SRE/operations pack (this standard's source)
|
|
105
|
+
- XSPEC-251 — Operator proactive reliability (runbook ownership)
|
|
106
|
+
- DEC-042 — Guardian / Governance Agent pattern (agent executes `automated` runbooks)
|
|
107
|
+
- DEC-041 — EU AI Act 2026 compliance (auditable recovery procedures)
|
|
108
|
+
|
|
109
|
+
## Changelog
|
|
110
|
+
|
|
111
|
+
| Version | Date | Changes |
|
|
112
|
+
|---------|------|---------|
|
|
113
|
+
| v1.0.0 | 2026-06-17 | Initial — REQ-001~006: required sections, reproducible steps, naming/organization, review/drill cadence, rollback/fallback, alert integration metadata (XSPEC-063) |
|
|
@@ -0,0 +1,105 @@
|
|
|
1
|
+
# Schema Evolution Standards
|
|
2
|
+
|
|
3
|
+
> **Version**: 1.0.0 | **Status**: Active | **Updated**: 2026-06-17
|
|
4
|
+
> **AI-optimized version**: `ai/standards/schema-evolution.ai.yaml`
|
|
5
|
+
> **Spec**: XSPEC-068 (cross-project/specs/XSPEC-068-uds-data-engineering-pack.md)
|
|
6
|
+
|
|
7
|
+
**Scope**: universal
|
|
8
|
+
|
|
9
|
+
## Overview
|
|
10
|
+
|
|
11
|
+
This standard defines how database and data-store schemas are **evolved safely**
|
|
12
|
+
without breaking existing consumers. It covers backward-compatible change patterns,
|
|
13
|
+
prohibited breaking changes, the expand-contract migration strategy, schema
|
|
14
|
+
versioning and registry, automated compatibility checking in CI, and rollback
|
|
15
|
+
procedures. It applies to relational databases, document stores, event schemas
|
|
16
|
+
(Avro/Protobuf), and API request/response schemas.
|
|
17
|
+
|
|
18
|
+
It is part of the **data-engineering pack** (XSPEC-068) and extends the
|
|
19
|
+
static-schema definitions in `database-standards` with safe evolution rules.
|
|
20
|
+
|
|
21
|
+
> **Scope.** This standard defines the *compatibility taxonomy*, the
|
|
22
|
+
> *expand-contract* deployment discipline, and CI gating. The concrete migration
|
|
23
|
+
> tool (Flyway/Liquibase) and schema registry (Confluent) are adoption choices.
|
|
24
|
+
|
|
25
|
+
## Requirements
|
|
26
|
+
|
|
27
|
+
| ID | Rule | Level |
|
|
28
|
+
|----|------|-------|
|
|
29
|
+
| REQ-001 | Backward-compatible change patterns | MUST |
|
|
30
|
+
| REQ-002 | Prohibited breaking changes without a migration plan | MUST |
|
|
31
|
+
| REQ-003 | Expand-contract migration strategy | MUST |
|
|
32
|
+
| REQ-004 | Schema versioning and registry | MUST |
|
|
33
|
+
| REQ-005 | Automated schema-compatibility checking in CI | MUST |
|
|
34
|
+
| REQ-006 | Schema-change rollback procedures | MUST |
|
|
35
|
+
|
|
36
|
+
### REQ-001 — Backward-Compatible Change Patterns
|
|
37
|
+
|
|
38
|
+
All schema changes MUST be backward-compatible unless a formal breaking-change
|
|
39
|
+
process is followed. Backward-compatible changes include: adding new nullable
|
|
40
|
+
columns/fields with defaults, adding new tables/collections, adding new optional
|
|
41
|
+
message fields, adding new enum values (with unknown handling), widening a data
|
|
42
|
+
type (INT → BIGINT), and adding indexes. These changes MUST be deployable without
|
|
43
|
+
coordinating consumer updates.
|
|
44
|
+
|
|
45
|
+
### REQ-002 — Prohibited Breaking Changes Without Migration Plan
|
|
46
|
+
|
|
47
|
+
The following are classified as **BREAKING** and MUST NOT be deployed without a
|
|
48
|
+
formal expand-contract migration plan and consumer coordination: renaming or
|
|
49
|
+
dropping columns/fields, changing data types incompatibly, adding NOT NULL to
|
|
50
|
+
existing columns without defaults, changing primary/foreign-key definitions,
|
|
51
|
+
removing enum values, and changing field semantics (repurposing a column).
|
|
52
|
+
|
|
53
|
+
### REQ-003 — Expand-Contract Migration Strategy
|
|
54
|
+
|
|
55
|
+
Breaking changes MUST use the **expand-contract** (parallel-change) pattern:
|
|
56
|
+
**Phase 1 (Expand)** add new structure alongside old; **Phase 2 (Migrate)**
|
|
57
|
+
backfill old → new and update all writers; **Phase 3 (Contract)** update all
|
|
58
|
+
readers to the new structure; **Phase 4 (Cleanup)** remove old structure after all
|
|
59
|
+
consumers are updated. Each phase MUST be a separate, verified deployment.
|
|
60
|
+
Minimum wait between phases: one full deployment cycle.
|
|
61
|
+
|
|
62
|
+
### REQ-004 — Schema Versioning and Registry
|
|
63
|
+
|
|
64
|
+
Event-driven and API schemas (Avro, Protobuf, JSON Schema) MUST be registered in a
|
|
65
|
+
schema registry with explicit version numbers following semantic versioning: PATCH
|
|
66
|
+
for backward-compatible additions, MINOR for new optional fields, MAJOR for
|
|
67
|
+
breaking changes. Every schema change MUST be reviewed and approved before
|
|
68
|
+
registration. Consumers MUST specify the schema version they consume.
|
|
69
|
+
|
|
70
|
+
### REQ-005 — Automated Schema Compatibility Checking in CI
|
|
71
|
+
|
|
72
|
+
Every PR modifying schema definitions MUST trigger automated compatibility checks
|
|
73
|
+
in CI. For relational schemas, migration scripts MUST be run against a
|
|
74
|
+
production-snapshot database in CI to detect errors before merge. For event
|
|
75
|
+
schemas, compatibility MUST be checked against all registered consumer versions.
|
|
76
|
+
Compatibility failures MUST block the PR merge.
|
|
77
|
+
|
|
78
|
+
### REQ-006 — Schema Change Rollback Procedures
|
|
79
|
+
|
|
80
|
+
Every migration script MUST have a corresponding rollback (down) script. Rollback
|
|
81
|
+
scripts MUST be tested in CI alongside the forward migration. For destructive
|
|
82
|
+
changes (drops, type changes), a data backup MUST be taken and verified before
|
|
83
|
+
execution. The rollback plan MUST be documented in the migration PR and referenced
|
|
84
|
+
in the deployment runbook.
|
|
85
|
+
|
|
86
|
+
## Integration with Existing Standards
|
|
87
|
+
|
|
88
|
+
- **`database-standards`** — this standard adds the *evolution* discipline on top
|
|
89
|
+
of static schema definitions.
|
|
90
|
+
- **`data-contract`** — MAJOR schema versions map to contract breaking-change
|
|
91
|
+
governance and consumer sign-off.
|
|
92
|
+
- **`data-pipeline`** — pipelines must tolerate backward-compatible source changes
|
|
93
|
+
per REQ-001.
|
|
94
|
+
- **`deployment-standards`** — expand-contract phases are separate deployments;
|
|
95
|
+
rollback plans live in the deployment runbook.
|
|
96
|
+
|
|
97
|
+
## Related Specs
|
|
98
|
+
|
|
99
|
+
- XSPEC-068 — UDS data-engineering pack (this standard's source)
|
|
100
|
+
|
|
101
|
+
## Changelog
|
|
102
|
+
|
|
103
|
+
| Version | Date | Changes |
|
|
104
|
+
|---------|------|---------|
|
|
105
|
+
| v1.0.0 | 2026-06-17 | Initial — REQ-001~006: backward-compatible patterns, prohibited breaking changes, expand-contract, versioning/registry, CI compatibility checks, rollback (XSPEC-068) |
|
|
@@ -0,0 +1,110 @@
|
|
|
1
|
+
# Secret Management and Credential Hygiene Standards
|
|
2
|
+
|
|
3
|
+
> **Version**: 1.0.0 | **Status**: Active | **Updated**: 2026-06-17
|
|
4
|
+
> **AI-optimized version**: `ai/standards/secret-management-standards.ai.yaml`
|
|
5
|
+
> **Spec**: XSPEC-065 (cross-project/specs/XSPEC-065-uds-infrastructure-pack.md)
|
|
6
|
+
|
|
7
|
+
**Scope**: universal
|
|
8
|
+
|
|
9
|
+
## Overview
|
|
10
|
+
|
|
11
|
+
This standard defines how teams store, inject, rotate, and audit secrets and
|
|
12
|
+
credentials across development and production environments. It covers three
|
|
13
|
+
approved secret source tiers (Vault dynamic secrets, Cloud KMS, SOPS+Git),
|
|
14
|
+
rotation policies by credential type, automated hardcoded-secret prevention via
|
|
15
|
+
pre-commit and CI scanning, and safe secret injection patterns. It is designed to
|
|
16
|
+
eliminate credentials from source code and CI logs while remaining operationally
|
|
17
|
+
practical across team sizes.
|
|
18
|
+
|
|
19
|
+
It is part of the **IaC pack** (XSPEC-065) and serves as the cross-cutting
|
|
20
|
+
*primary owner* for secret handling: it is referenced by container image builds
|
|
21
|
+
(`container-image-standards`), compliance auditing (`audit-trail`), and SRE
|
|
22
|
+
runbooks that store credentials.
|
|
23
|
+
|
|
24
|
+
> **Scope.** This standard defines the *approved sources*, *rotation cadence*,
|
|
25
|
+
> *prevention layers*, and *injection patterns* for secrets. The choice between
|
|
26
|
+
> Vault / Cloud KMS / SOPS and the specific scanning tool are adoption choices.
|
|
27
|
+
|
|
28
|
+
## Requirements
|
|
29
|
+
|
|
30
|
+
| ID | Rule | Level |
|
|
31
|
+
|----|------|-------|
|
|
32
|
+
| REQ-001 | Secret source three options (Vault / Cloud KMS / SOPS+Git) | MUST |
|
|
33
|
+
| REQ-002 | Rotation policy by type | MUST |
|
|
34
|
+
| REQ-003 | Hardcoded secret prevention (pre-commit + CI scan) | MUST |
|
|
35
|
+
| REQ-004 | Secret injection (env vars or mounted files only) | MUST |
|
|
36
|
+
|
|
37
|
+
### REQ-001 — Secret Source Three Options
|
|
38
|
+
|
|
39
|
+
Teams MUST use one of three approved secret source tiers based on operational
|
|
40
|
+
context: (1) **HashiCorp Vault dynamic secrets** (preferred for production and
|
|
41
|
+
multi-team environments) — secrets generated on-demand with short TTLs, no static
|
|
42
|
+
credentials stored anywhere; (2) **Cloud KMS with native secret managers** (AWS
|
|
43
|
+
Secrets Manager / GCP Secret Manager / Azure Key Vault) — suitable for
|
|
44
|
+
cloud-native deployments, secrets fetched at runtime via IAM-controlled API
|
|
45
|
+
calls; (3) **SOPS + Git encryption** — suitable for small teams and GitOps
|
|
46
|
+
workflows, secrets encrypted with `age` or a KMS key before committing and
|
|
47
|
+
decrypted only in trusted runtime environments. Storing unencrypted secrets in
|
|
48
|
+
any other location (env files, wiki, chat) is **PROHIBITED**.
|
|
49
|
+
|
|
50
|
+
### REQ-002 — Rotation Policy by Type
|
|
51
|
+
|
|
52
|
+
All secrets MUST have a defined rotation policy enforced by automated tooling or
|
|
53
|
+
calendar reminders. Minimum rotation frequencies by type: **Database
|
|
54
|
+
credentials** — every 90 days; **API keys** (third-party services) — every 180
|
|
55
|
+
days; **Signing keys** (JWT, code signing) — every 365 days; **One-time tokens
|
|
56
|
+
and session credentials** — revoke immediately after use, MUST NOT be reused;
|
|
57
|
+
**TLS certificates** — rotate at least 30 days before expiry, automate with
|
|
58
|
+
ACME/Let's Encrypt or cert-manager where possible. Rotation events MUST be logged
|
|
59
|
+
in the audit trail.
|
|
60
|
+
|
|
61
|
+
### REQ-003 — Hardcoded Secret Prevention
|
|
62
|
+
|
|
63
|
+
Teams MUST implement automated scanning to detect and block hardcoded secrets
|
|
64
|
+
before they reach the repository. Two layers are REQUIRED: (1) **Pre-commit hook**
|
|
65
|
+
using `detect-secrets`, `gitleaks`, or `truffleHog` — scans staged files and
|
|
66
|
+
blocks the commit if patterns are detected; (2) **CI pipeline scan** — rescans
|
|
67
|
+
all changed files on every PR and blocks merge if secrets are found. Minimum
|
|
68
|
+
detected patterns: AWS access key format (`AKIA[0-9A-Z]{16}`), PEM private key
|
|
69
|
+
headers (`-----BEGIN .* PRIVATE KEY`), generic API token patterns
|
|
70
|
+
(`api[_-]?key\s*[:=]\s*\S{16,}`), and connection strings containing passwords.
|
|
71
|
+
|
|
72
|
+
### REQ-004 — Secret Injection
|
|
73
|
+
|
|
74
|
+
Secrets MUST be injected into application processes via environment variables or
|
|
75
|
+
mounted files only. Passing secrets via command-line arguments is **PROHIBITED**
|
|
76
|
+
(visible in process lists). Passing secrets via URL query parameters is
|
|
77
|
+
**PROHIBITED** (logged by proxies and servers). For environment variable
|
|
78
|
+
injection, use the platform's native secret injection (Kubernetes Secrets, ECS
|
|
79
|
+
task definition secrets, GitHub Actions secrets). For file-based injection, mount
|
|
80
|
+
secrets as read-only volumes with restrictive file permissions (0400 or 0600).
|
|
81
|
+
|
|
82
|
+
## Anti-Patterns
|
|
83
|
+
|
|
84
|
+
- Hardcoding credentials directly in source code or configuration files.
|
|
85
|
+
- Storing secrets in CI/CD environment variables without encryption (plaintext in UI).
|
|
86
|
+
- Sharing credentials across multiple environments (dev/staging/prod use same secret).
|
|
87
|
+
- Long-lived static credentials without rotation schedules.
|
|
88
|
+
- Committing `.env` files containing real secrets to version control.
|
|
89
|
+
|
|
90
|
+
## Integration with Existing Standards
|
|
91
|
+
|
|
92
|
+
- **`iac-design-principles`** — secret backends (Vault/KMS state) are themselves
|
|
93
|
+
versioned, access-controlled infrastructure.
|
|
94
|
+
- **`audit-trail`** — rotation, access, and injection events are auditable
|
|
95
|
+
operations (REQ-002 mandates logging rotation events).
|
|
96
|
+
- **`pii-classification`** — credentials guarding TIER-1 PII inherit the strictest
|
|
97
|
+
handling controls.
|
|
98
|
+
- **`security-standards`** — this standard is the credential-hygiene facet of the
|
|
99
|
+
broader security baseline.
|
|
100
|
+
|
|
101
|
+
## Related Specs
|
|
102
|
+
|
|
103
|
+
- XSPEC-065 — UDS infrastructure (IaC) pack (this standard's source)
|
|
104
|
+
- DEC-043 — UDS coverage completeness roadmap (Wave 4 scope; D1 cross-cutting owner)
|
|
105
|
+
|
|
106
|
+
## Changelog
|
|
107
|
+
|
|
108
|
+
| Version | Date | Changes |
|
|
109
|
+
|---------|------|---------|
|
|
110
|
+
| v1.0.0 | 2026-06-17 | Initial — REQ-001~004: secret source options, rotation policy, hardcoded-secret prevention, secret injection (XSPEC-065) |
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
# Security Testing Standards
|
|
2
2
|
|
|
3
|
-
**Version**: 1.
|
|
4
|
-
**Last Updated**: 2026-
|
|
3
|
+
**Version**: 1.1.0
|
|
4
|
+
**Last Updated**: 2026-06-19
|
|
5
5
|
**Applicability**: All software projects
|
|
6
6
|
**Scope**: universal
|
|
7
7
|
**Industry Standards**: OWASP Testing Guide v4, NIST SP 800-115, ISO/IEC 27001
|
|
@@ -71,6 +71,30 @@ Tools: OWASP ZAP, Nuclei
|
|
|
71
71
|
|
|
72
72
|
---
|
|
73
73
|
|
|
74
|
+
## Finding Remediation Lifecycle
|
|
75
|
+
|
|
76
|
+
The layers above detect findings and the CVE policy sets resolution SLAs, but a
|
|
77
|
+
finding also needs an **owned lifecycle** — otherwise "block merge" is the only
|
|
78
|
+
defined action and everything after detection is undefined. Every security
|
|
79
|
+
finding (SAST / DAST / secret / dependency CVE) follows this state machine.
|
|
80
|
+
|
|
81
|
+
| State | Meaning | Owner | Exit condition |
|
|
82
|
+
|-------|---------|-------|----------------|
|
|
83
|
+
| **Detected** | A layer (SAST/DAST/secret/audit) raised it | the scanning gate (CI) | severity assigned |
|
|
84
|
+
| **Triaged** | Severity + validity confirmed (real vs false positive) | security reviewer | real → In-Progress; false-positive → `suppressed` with recorded justification |
|
|
85
|
+
| **In-Progress** | Fix being implemented | code owner of the affected component | a fix is committed |
|
|
86
|
+
| **Resolved** | Fix merged | code owner | the originating scan re-runs clean |
|
|
87
|
+
| **Verified** | Re-scan confirms the finding is gone | the scanning gate (CI) | finding closed |
|
|
88
|
+
|
|
89
|
+
- **Gate**: a Critical/High finding in any state other than `Verified` (or
|
|
90
|
+
`Triaged → suppressed` with justification) **blocks release**, consistent with
|
|
91
|
+
the CVE Response Policy SLAs above.
|
|
92
|
+
- **No silent close**: a finding may only leave the lifecycle via `Verified`
|
|
93
|
+
(re-scan clean) or an explicit, recorded `suppressed` decision by the security
|
|
94
|
+
reviewer — never by deletion, nor by the fix author self-approving.
|
|
95
|
+
|
|
96
|
+
---
|
|
97
|
+
|
|
74
98
|
## Anti-Patterns
|
|
75
99
|
|
|
76
100
|
- Treating all CVEs as equal urgency
|
|
@@ -16,7 +16,7 @@
|
|
|
16
16
|
This standard mandates a **self-review pass** on large markdown edits before commit, to catch internal cross-reference inconsistencies that internal reasoning routinely misses.
|
|
17
17
|
|
|
18
18
|
**Relationship to Other Standards**:
|
|
19
|
-
- Complements [code-review.md](code-review.md) which covers code changes
|
|
19
|
+
- Complements [code-review.md](code-review-checklist.md) which covers code changes
|
|
20
20
|
- Complements [documentation-writing-standards.md](documentation-writing-standards.md) which covers content creation
|
|
21
21
|
- This standard focuses on **post-edit verification** of large markdown documents (DECs, ADRs, XSPECs, SKILL.md, spec documents, runbooks)
|
|
22
22
|
|
|
@@ -119,7 +119,7 @@ Self-review (protocol v1.0.0): N issues found, M applied in same commit / 0 foun
|
|
|
119
119
|
|
|
120
120
|
| Practice | Covers | Trigger |
|
|
121
121
|
|---|---|---|
|
|
122
|
-
| **Code Review** ([code-review.md](code-review.md)) | Code correctness, design, security | Before merging code PR |
|
|
122
|
+
| **Code Review** ([code-review.md](code-review-checklist.md)) | Code correctness, design, security | Before merging code PR |
|
|
123
123
|
| **Content Self-Audit** (e.g., eval-source skill's 7-question audit) | Content completeness (did we include all required sections?) | Each artefact creation |
|
|
124
124
|
| **Self-Review Protocol** (this standard) | Internal cross-reference consistency (form, not content) | After large markdown edit, before commit |
|
|
125
125
|
| **Peer Review** | Independent perspective, blast radius assessment | Significant changes |
|
|
@@ -1,6 +1,9 @@
|
|
|
1
1
|
# Skill-Standard Alignment Check
|
|
2
2
|
|
|
3
3
|
> **Source**: XSPEC-070 | **Driven by**: DEC-043 Wave 1 Governance Meta Pack | **Status**: Trial (2026-04-17 ~ 2026-10-17)
|
|
4
|
+
>
|
|
5
|
+
> **Phase 1**(anchor 存在性 / orphan 偵測)— Implemented。
|
|
6
|
+
> **Phase 2**(content-coverage audit:版本偏移 / mandatory keyword / 規模落差)— Implemented(XSPEC-292 T4,`scripts/check-skill-content-coverage.ts`)。
|
|
4
7
|
|
|
5
8
|
## Overview
|
|
6
9
|
|
|
@@ -57,6 +60,45 @@ Skill 必有 Standard 作為錨點,Standard 可無 Skill;定期識別孤兒
|
|
|
57
60
|
5. 驗證 anchor 指向存在且非 Archived 的 id
|
|
58
61
|
6. 產出 `alignment-report.json` / `alignment-report.md`
|
|
59
62
|
|
|
63
|
+
## Content-Coverage Audit(Phase 2)
|
|
64
|
+
|
|
65
|
+
> **Driven by**: XSPEC-292 T4(3 個真實 skill↔standard 內容漂移)。Phase 1 只證明 anchor
|
|
66
|
+
> *存在*(防 orphan);一個 Skill 可帶著有效 `anchor_standard` 仍漂移——標準新增 mandatory
|
|
67
|
+
> 段落、bump 版本、或成長到遠超 Skill 的陳舊摘要。Phase 2 把對齊從「錨點存在」延伸到
|
|
68
|
+
> 「錨點內容同步」。
|
|
69
|
+
|
|
70
|
+
每個 `(skill, anchor_standard)` 配對執行三項內容層檢查(預設 advisory,`--strict` 轉硬閘):
|
|
71
|
+
|
|
72
|
+
| 檢查 | 錯誤碼 | 觸發條件 |
|
|
73
|
+
|------|--------|----------|
|
|
74
|
+
| **版本偏移** | `CONTENT-001` | Skill `**Version**` < anchor 標準版本(取自 `core/<id>.md`)。Skill 無版本則記 `CONTENT-001A`(advisory,永不阻擋)。 |
|
|
75
|
+
| **mandatory keyword 覆蓋** | `CONTENT-002` | 標準在 `.ai.yaml` 宣告為 mandatory 的關鍵字(`audit.mandatory_keywords`)未出現在 Skill 內文。 |
|
|
76
|
+
| **規模落差** | `CONTENT-003` | Skill 行數 / 標準行數 < `audit.min_skill_ratio`(預設 0.15),即 underspecified 骨架。 |
|
|
77
|
+
|
|
78
|
+
### Audit 宣告(標準側 opt-in)
|
|
79
|
+
|
|
80
|
+
mandatory keyword 與規模門檻由**標準自己**在其 `.ai.yaml` 宣告(反幻覺:審核器不臆測什麼是
|
|
81
|
+
mandatory,只讀標準作者明文宣告的清單)。支援兩種 schema 位置:頂層 `audit:` 或 `standard.audit:`。
|
|
82
|
+
|
|
83
|
+
```yaml
|
|
84
|
+
# ai/standards/logging.ai.yaml
|
|
85
|
+
audit:
|
|
86
|
+
mandatory_keywords: # logging 的 9 canonical events
|
|
87
|
+
- application_startup
|
|
88
|
+
- request_received
|
|
89
|
+
# ...
|
|
90
|
+
min_skill_ratio: 0.15 # 選填,覆寫預設
|
|
91
|
+
```
|
|
92
|
+
|
|
93
|
+
### Advisory → Strict 升級路徑
|
|
94
|
+
|
|
95
|
+
- 預設 **advisory**:列出所有 finding,exit 0,讓 audit 能在所有漂移修完前先落地。
|
|
96
|
+
- `--strict`:將 `CONTENT-001/002/003` 升為阻擋失敗(exit 1);`CONTENT-001A`(無版本)始終
|
|
97
|
+
資訊性、永不阻擋。
|
|
98
|
+
- 建議:先以 advisory 進 CI 觀察 → 漂移清零後於 pre-release gate 加 `--strict`。
|
|
99
|
+
|
|
100
|
+
腳本:`scripts/check-skill-content-coverage.ts`(npm script `check:content-coverage`)。
|
|
101
|
+
|
|
60
102
|
## Usage Examples
|
|
61
103
|
|
|
62
104
|
- **Scenario 1 — 健康對齊**:`retry-assistant` frontmatter 含 `anchor_standard: retry-standards`,指向 Trial 狀態標準 → 檢查通過
|
|
@@ -65,14 +107,25 @@ Skill 必有 Standard 作為錨點,Standard 可無 Skill;定期識別孤兒
|
|
|
65
107
|
|
|
66
108
|
## Error Codes
|
|
67
109
|
|
|
110
|
+
Phase 1(anchor 存在性):
|
|
111
|
+
|
|
68
112
|
- `ALIGN-001` — `SKILL_MISSING_ANCHOR`
|
|
69
113
|
- `ALIGN-002` — `BROKEN_ANCHOR`(指向不存在的 standard id)
|
|
70
114
|
- `ALIGN-003` — `ARCHIVED_ANCHOR`(指向已 Archived 的標準)
|
|
71
115
|
- `ALIGN-004` — `UTILITY_MISSING_REASON`
|
|
72
116
|
|
|
117
|
+
Phase 2(內容覆蓋):
|
|
118
|
+
|
|
119
|
+
- `CONTENT-001` — `VERSION_SKEW`(Skill 版本 < anchor 標準版本,stale;blocking under `--strict`)
|
|
120
|
+
- `CONTENT-001A` — `SKILL_UNVERSIONED`(Skill 無版本,無法比對;advisory only)
|
|
121
|
+
- `CONTENT-002` — `MISSING_MANDATORY_KEYWORD`(標準宣告的 mandatory keyword 未出現於 Skill)
|
|
122
|
+
- `CONTENT-003` — `UNDERSPECIFIED`(Skill 規模遠小於 anchor 標準)
|
|
123
|
+
- `CONTENT-000` — `ANCHOR_NOT_IN_REGISTRY`(內容覆蓋無法評估;broken anchor 屬 ALIGN-002 領域)
|
|
124
|
+
|
|
73
125
|
## References
|
|
74
126
|
|
|
75
127
|
- AI-optimized: [ai/standards/skill-standard-alignment-check.ai.yaml](../ai/standards/skill-standard-alignment-check.ai.yaml)
|
|
128
|
+
- Phase 2 audit 腳本: `scripts/check-skill-content-coverage.ts`(npm `check:content-coverage`)
|
|
76
129
|
- XSPEC-070: DEC-043 Wave 1 Governance Meta Pack 跨專案規格
|
|
77
130
|
- DEC-043: UDS 覆蓋完整性路線圖(XSPEC-063~069 目的之一即清空本標準識別的 orphan 清單)
|
|
78
131
|
- Related: `standard-admission-criteria`, `standard-lifecycle-management`
|
|
@@ -0,0 +1,109 @@
|
|
|
1
|
+
# SLO/SLI Definition Standards
|
|
2
|
+
|
|
3
|
+
> **Version**: 1.0.0 | **Status**: Active | **Updated**: 2026-06-17
|
|
4
|
+
> **AI-optimized version**: `ai/standards/slo-sli.ai.yaml`
|
|
5
|
+
> **Spec**: XSPEC-063 (cross-project/specs/XSPEC-063-uds-sre-standards-pack.md)
|
|
6
|
+
|
|
7
|
+
**Scope**: universal
|
|
8
|
+
|
|
9
|
+
## Overview
|
|
10
|
+
|
|
11
|
+
This standard defines how teams **select, measure, and govern Service Level
|
|
12
|
+
Indicators (SLIs) and Service Level Objectives (SLOs)**. It covers SLI selection
|
|
13
|
+
per service type, SLO target-setting methodology, error-budget policies, and
|
|
14
|
+
multi-window burn-rate alerting. It is designed to bridge engineering reliability
|
|
15
|
+
work with customer-facing SLA commitments.
|
|
16
|
+
|
|
17
|
+
It is part of the **SRE/operations pack** (XSPEC-063) and is the
|
|
18
|
+
reliability-target member alongside `incident-response` (error-budget burn often
|
|
19
|
+
triggers incidents) and `runbook` (the error-budget policy is linked from the
|
|
20
|
+
service runbook). It complements the existing `slo-standards` Skill anchor and
|
|
21
|
+
feeds the proactive reliability ownership described in XSPEC-251 (Operator).
|
|
22
|
+
|
|
23
|
+
> **Scope.** This standard defines *how to choose SLIs, set SLO targets, and
|
|
24
|
+
> govern error budgets*. The metrics backend (Prometheus, Datadog), the dashboard
|
|
25
|
+
> product, and the alerting tool are adoption choices, not part of this standard.
|
|
26
|
+
|
|
27
|
+
## Requirements
|
|
28
|
+
|
|
29
|
+
| ID | Rule | Level |
|
|
30
|
+
|----|------|-------|
|
|
31
|
+
| REQ-001 | SLI selection per service type (API / batch / frontend) | MUST |
|
|
32
|
+
| REQ-002 | SLO target-setting methodology (historical P5 baseline + buffer) | MUST |
|
|
33
|
+
| REQ-003 | Error budget policy (freeze + reliability-sprint triggers) | MUST |
|
|
34
|
+
| REQ-004 | Multi-window burn-rate alerting (fast / medium / slow burn) | SHOULD |
|
|
35
|
+
| REQ-005 | SLO documentation and review cadence (standard spec + quarterly review) | MUST |
|
|
36
|
+
| REQ-006 | SLO compliance reporting (monthly stakeholder report) | SHOULD |
|
|
37
|
+
|
|
38
|
+
### REQ-001 — SLI Selection Per Service Type
|
|
39
|
+
|
|
40
|
+
Every production service MUST define at least one SLI matched to its service type.
|
|
41
|
+
API services MUST measure availability (non-5xx / total) and latency (proportion
|
|
42
|
+
of requests below a threshold). Batch jobs MUST measure freshness (data lag ≤
|
|
43
|
+
threshold) and correctness (successfully processed / total). Frontend services
|
|
44
|
+
MUST measure Core Web Vitals (LCP < 2.5s, FID < 100ms, CLS < 0.1).
|
|
45
|
+
|
|
46
|
+
### REQ-002 — SLO Target Setting Methodology
|
|
47
|
+
|
|
48
|
+
SLO targets MUST be set using historical baseline data. Teams MUST start from the
|
|
49
|
+
observed P5 performance (the 5th-percentile worst period) over at least 28 rolling
|
|
50
|
+
days, then add a small buffer. The SLO target MUST be strictly higher than any
|
|
51
|
+
external SLA commitment (e.g., SLA 99.9% → SLO ≥ 99.95%). Never set an SLO equal
|
|
52
|
+
to the SLA; maintain a ≥ 0.05% buffer.
|
|
53
|
+
|
|
54
|
+
### REQ-003 — Error Budget Policy
|
|
55
|
+
|
|
56
|
+
Every service with an SLO MUST have a written Error Budget Policy specifying
|
|
57
|
+
actions when the error budget is partially or fully exhausted. At minimum the
|
|
58
|
+
policy MUST define: (1) a freeze threshold (typically 50% exhausted → release
|
|
59
|
+
freeze), (2) a reliability-sprint trigger (100% exhausted), and (3) an SLO review
|
|
60
|
+
cadence (quarterly). The error-budget computation follows
|
|
61
|
+
`budget = (1 − SLO) × time window` (e.g., 99.9% over 30 days → 43.2 minutes).
|
|
62
|
+
|
|
63
|
+
### REQ-004 — Multi-Window Burn-Rate Alerting
|
|
64
|
+
|
|
65
|
+
Teams SHOULD implement multi-window burn-rate alerts to catch both fast and slow
|
|
66
|
+
budget exhaustion. Recommended thresholds: fast burn (2% of monthly budget
|
|
67
|
+
consumed in 1 hour → P1 page), medium burn (5% in 6 hours → P2 alert), slow burn
|
|
68
|
+
(10% in 3 days → P3 ticket).
|
|
69
|
+
|
|
70
|
+
### REQ-005 — SLO Documentation and Review Cadence
|
|
71
|
+
|
|
72
|
+
Each SLO MUST be documented in a standard SLO spec file containing: service name,
|
|
73
|
+
SLI formula, measurement window, target value, error budget, alerting thresholds,
|
|
74
|
+
and owner. SLO specs MUST be reviewed quarterly and updated within 2 weeks of any
|
|
75
|
+
major architecture change.
|
|
76
|
+
|
|
77
|
+
### REQ-006 — SLO Compliance Reporting
|
|
78
|
+
|
|
79
|
+
Teams SHOULD publish a monthly SLO compliance report to stakeholders. The report
|
|
80
|
+
MUST include achieved vs. target SLI value, error budget remaining, significant
|
|
81
|
+
incidents affecting the SLO, and planned reliability improvements. Dashboard links
|
|
82
|
+
MUST be included.
|
|
83
|
+
|
|
84
|
+
## Integration with Existing Standards
|
|
85
|
+
|
|
86
|
+
- **`slo-standards`** — the existing Skill-anchor standard; `slo-sli` provides the
|
|
87
|
+
detailed selection/target/error-budget methodology behind it.
|
|
88
|
+
- **`incident-response`** — error-budget burn-rate alerts feed incident
|
|
89
|
+
declaration and severity assessment.
|
|
90
|
+
- **`runbook`** — the error-budget policy MUST be linked from the service runbook.
|
|
91
|
+
- **`rollback-standards`** — error-budget exhaustion can trigger a deployment
|
|
92
|
+
freeze and, downstream, automated rollback.
|
|
93
|
+
- **`observability-standards`** — SLIs are computed from the metric/log/trace
|
|
94
|
+
pillars defined there.
|
|
95
|
+
- **`alerting-standards`** — burn-rate alerts follow the symptom-based alerting
|
|
96
|
+
and severity grading rules.
|
|
97
|
+
|
|
98
|
+
## Related Specs
|
|
99
|
+
|
|
100
|
+
- XSPEC-063 — UDS SRE/operations pack (this standard's source)
|
|
101
|
+
- XSPEC-251 — Operator proactive reliability (SLO ownership upstream of incidents)
|
|
102
|
+
- DEC-041 — EU AI Act 2026 compliance (reliability evidence)
|
|
103
|
+
- DEC-042 — Guardian / Governance Agent pattern (error-budget-driven actions)
|
|
104
|
+
|
|
105
|
+
## Changelog
|
|
106
|
+
|
|
107
|
+
| Version | Date | Changes |
|
|
108
|
+
|---------|------|---------|
|
|
109
|
+
| v1.0.0 | 2026-06-17 | Initial — REQ-001~006: SLI selection, SLO target methodology, error-budget policy, burn-rate alerting, SLO documentation/review, compliance reporting (XSPEC-063) |
|
|
@@ -60,7 +60,7 @@ echo "=== PASS ==="
|
|
|
60
60
|
|
|
61
61
|
## Related Standards
|
|
62
62
|
|
|
63
|
-
- [Testing Standards](testing.md) — overall test pyramid
|
|
63
|
+
- [Testing Standards](testing-standards.md) — overall test pyramid
|
|
64
64
|
- [Deployment Standards](deployment-standards.md) — deployment pipeline
|
|
65
65
|
- [Performance Standards](performance-standards.md) — latency SLOs
|
|
66
66
|
|
|
@@ -54,7 +54,7 @@ Every technical debt item must be recorded in a registry with the following 11 f
|
|
|
54
54
|
| 1 | **ID** | Unique identifier using `TD-NNN` format | TD-001 |
|
|
55
55
|
| 2 | **Title** | Short descriptive title | "Monolithic auth module needs decomposition" |
|
|
56
56
|
| 3 | **Type** | One of the 6 debt types above | Design |
|
|
57
|
-
| 4 | **Source** | How the debt was introduced (deliberate/inadvertent) | Deliberate |
|
|
57
|
+
| 4 | **Source** | How the debt was introduced (deliberate / inadvertent / incident-postmortem — see [postmortem-standards](postmortem-standards.md) action-item hand-off) | Deliberate (or `postmortem PM-042`) |
|
|
58
58
|
| 5 | **Impact** | Business and technical impact description | "Slows feature development by ~2 days per sprint" |
|
|
59
59
|
| 6 | **Estimated Cost** | Effort to resolve (story points or person-days) | 8 story points |
|
|
60
60
|
| 7 | **Interest** | Ongoing cost of not resolving (see Interest Types) | 1 day/sprint additional debugging |
|
|
@@ -296,8 +296,8 @@ ID? → Hash / UUID / sequential
|
|
|
296
296
|
|
|
297
297
|
- [Testing Standards](testing-standards.md) — Test levels, coverage, and quality requirements
|
|
298
298
|
- [Security Standards](security-standards.md) — Data protection and PII handling
|
|
299
|
-
- [Unit Testing Standards](unit-testing
|
|
300
|
-
- [Integration Testing Standards](integration-testing
|
|
299
|
+
- [Unit Testing Standards](../options/testing/unit-testing.md) — Unit test patterns and best practices
|
|
300
|
+
- [Integration Testing Standards](../options/testing/integration-testing.md) — Integration test strategies
|
|
301
301
|
|
|
302
302
|
---
|
|
303
303
|
|