universal-dev-standards 6.7.5 → 6.9.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 +19 -2
- package/bundled/ai/standards/acceptance-criteria-traceability.ai.yaml +14 -2
- package/bundled/ai/standards/adr-standards.ai.yaml +14 -2
- package/bundled/ai/standards/ai-instruction-standards.ai.yaml +6 -6
- package/bundled/ai/standards/code-review.ai.yaml +13 -3
- package/bundled/ai/standards/commit-message.ai.yaml +8 -4
- package/bundled/ai/standards/deferred-item-exit.ai.yaml +225 -0
- package/bundled/ai/standards/feature-discovery-standards.ai.yaml +14 -2
- package/bundled/ai/standards/governance-layer.ai.yaml +128 -2
- package/bundled/ai/standards/logging.ai.yaml +2 -2
- package/bundled/ai/standards/retrospective-standards.ai.yaml +14 -2
- package/bundled/ai/standards/reverse-engineering-standards.ai.yaml +73 -2
- package/bundled/ai/standards/security-standards.ai.yaml +2 -2
- package/bundled/ai/standards/spec-driven-development.ai.yaml +14 -2
- package/bundled/ai/standards/tech-debt-standards.ai.yaml +87 -3
- package/bundled/ai/standards/turn-completion-integrity.ai.yaml +131 -0
- package/bundled/core/acceptance-criteria-traceability.md +5 -2
- package/bundled/core/adr-standards.md +26 -2
- package/bundled/core/ai-instruction-standards.md +9 -7
- package/bundled/core/code-review-checklist.md +5 -2
- package/bundled/core/context-aware-loading.md +1 -1
- package/bundled/core/deferred-item-exit.md +254 -0
- package/bundled/core/feature-discovery-standards.md +5 -1
- package/bundled/core/governance-layer.md +114 -2
- package/bundled/core/retrospective-standards.md +4 -2
- package/bundled/core/reverse-engineering-standards.md +81 -2
- package/bundled/core/spec-driven-development.md +8 -2
- package/bundled/core/tech-debt-standards.md +67 -8
- package/bundled/core/turn-completion-integrity.md +196 -0
- package/bundled/hooks/check-dangerous-cmd.mjs +60 -0
- package/bundled/hooks/check-logging-standard.mjs +59 -0
- package/bundled/hooks/check-turn-completion.mjs +233 -0
- package/bundled/hooks/inject-standards.mjs +183 -0
- package/bundled/hooks/telemetry-wrapper.mjs +77 -0
- package/bundled/hooks/turn-completion/detect.mjs +99 -0
- package/bundled/hooks/turn-completion/locales/en.mjs +159 -0
- package/bundled/hooks/turn-completion/locales/zh-TW.mjs +166 -0
- package/bundled/hooks/validate-commit-msg.mjs +104 -0
- package/bundled/locales/zh-CN/CHANGELOG.md +65 -3
- package/bundled/locales/zh-CN/CLAUDE.md +1 -1
- package/bundled/locales/zh-CN/README.md +7 -7
- package/bundled/locales/zh-CN/SECURITY.md +1 -1
- package/bundled/locales/zh-CN/core/adr-standards.md +1 -1
- package/bundled/locales/zh-CN/core/ai-instruction-standards.md +10 -8
- package/bundled/locales/zh-CN/core/governance-layer.md +118 -6
- package/bundled/locales/zh-CN/core/retrospective-standards.md +1 -1
- package/bundled/locales/zh-CN/core/tech-debt-standards.md +71 -4
- package/bundled/locales/zh-CN/core/turn-completion-integrity.md +190 -0
- package/bundled/locales/zh-CN/docs/CHEATSHEET.md +27 -6
- package/bundled/locales/zh-CN/docs/CLI-INIT-OPTIONS.md +29 -68
- package/bundled/locales/zh-CN/docs/FEATURE-REFERENCE.md +172 -24
- package/bundled/locales/zh-CN/docs/USAGE-MODES-COMPARISON.md +1 -2
- package/bundled/locales/zh-CN/integrations/google-antigravity/{INSTRUCTIONS.md → AGENTS.md} +1 -1
- package/bundled/locales/zh-CN/integrations/google-antigravity/README.md +3 -3
- package/bundled/locales/zh-CN/skills/agents/README.md +1 -1
- package/bundled/locales/zh-CN/skills/atdd-assistant/SKILL.md +2 -0
- package/bundled/locales/zh-CN/skills/bdd-assistant/SKILL.md +2 -0
- package/bundled/locales/zh-CN/skills/brainstorm-assistant/SKILL.md +22 -12
- package/bundled/locales/zh-CN/skills/brainstorm-assistant/guide.md +12 -9
- package/bundled/locales/zh-CN/skills/code-review-assistant/SKILL.md +1 -0
- package/bundled/locales/zh-CN/skills/commands/brainstorm.md +17 -13
- package/bundled/locales/zh-CN/skills/commands/config.md +0 -1
- package/bundled/locales/zh-CN/skills/commands/init.md +1 -2
- package/bundled/locales/zh-CN/skills/commit-standards/SKILL.md +2 -0
- package/bundled/locales/zh-CN/skills/contract-test-assistant/SKILL.md +1 -0
- package/bundled/locales/zh-CN/skills/dev-methodology/SKILL.md +2 -0
- package/bundled/locales/zh-CN/skills/observability-assistant/SKILL.md +1 -0
- package/bundled/locales/zh-CN/skills/project-structure-guide/SKILL.md +1 -0
- package/bundled/locales/zh-CN/skills/release-standards/SKILL.md +3 -0
- package/bundled/locales/zh-CN/skills/requirement-assistant/SKILL.md +2 -0
- package/bundled/locales/zh-CN/skills/reverse-engineer/SKILL.md +3 -0
- package/bundled/locales/zh-CN/skills/reverse-engineer/tdd-analysis.md +13 -23
- package/bundled/locales/zh-CN/skills/runbook-assistant/SKILL.md +1 -0
- package/bundled/locales/zh-CN/skills/slo-assistant/SKILL.md +1 -0
- package/bundled/locales/zh-CN/skills/tdd-assistant/SKILL.md +2 -0
- package/bundled/locales/zh-CN/skills/workflows/README.md +2 -11
- package/bundled/locales/zh-TW/CHANGELOG.md +65 -3
- package/bundled/locales/zh-TW/CLAUDE.md +1 -1
- package/bundled/locales/zh-TW/README.md +7 -7
- package/bundled/locales/zh-TW/SECURITY.md +1 -1
- package/bundled/locales/zh-TW/core/acceptance-criteria-traceability.md +2 -0
- package/bundled/locales/zh-TW/core/adr-standards.md +26 -5
- package/bundled/locales/zh-TW/core/ai-instruction-standards.md +10 -8
- package/bundled/locales/zh-TW/core/code-review-checklist.md +2 -0
- package/bundled/locales/zh-TW/core/container-image-standards.md +2 -2
- package/bundled/locales/zh-TW/core/contract-testing-standards.md +2 -2
- package/bundled/locales/zh-TW/core/cross-flow-regression.md +8 -7
- package/bundled/locales/zh-TW/core/data-contract.md +2 -2
- package/bundled/locales/zh-TW/core/data-migration-testing.md +2 -2
- package/bundled/locales/zh-TW/core/data-pipeline.md +2 -2
- package/bundled/locales/zh-TW/core/deferred-item-exit.md +251 -0
- package/bundled/locales/zh-TW/core/documentation-writing-standards.md +228 -3
- package/bundled/locales/zh-TW/core/full-coverage-testing.md +15 -2
- package/bundled/locales/zh-TW/core/governance-layer.md +118 -5
- package/bundled/locales/zh-TW/core/iac-design-principles.md +2 -2
- package/bundled/locales/zh-TW/core/incident-response.md +2 -2
- package/bundled/locales/zh-TW/core/model-provenance.md +4 -2
- package/bundled/locales/zh-TW/core/pii-classification.md +42 -6
- package/bundled/locales/zh-TW/core/prd-standards.md +4 -2
- package/bundled/locales/zh-TW/core/product-metrics-standards.md +4 -2
- package/bundled/locales/zh-TW/core/release-readiness-gate.md +2 -2
- package/bundled/locales/zh-TW/core/resource-cost-boundary.md +2 -2
- package/bundled/locales/zh-TW/core/retrospective-standards.md +5 -3
- package/bundled/locales/zh-TW/core/reverse-engineering-standards.md +83 -5
- package/bundled/locales/zh-TW/core/runbook.md +2 -2
- package/bundled/locales/zh-TW/core/schema-evolution.md +2 -2
- package/bundled/locales/zh-TW/core/secret-management-standards.md +2 -2
- package/bundled/locales/zh-TW/core/slo-sli.md +2 -2
- package/bundled/locales/zh-TW/core/spec-driven-development.md +2 -0
- package/bundled/locales/zh-TW/core/tech-debt-standards.md +71 -4
- package/bundled/locales/zh-TW/core/turn-completion-integrity.md +190 -0
- package/bundled/locales/zh-TW/core/user-journey-testing.md +2 -2
- package/bundled/locales/zh-TW/core/user-story-mapping.md +2 -2
- package/bundled/locales/zh-TW/core/verification-oracle.md +2 -2
- package/bundled/locales/zh-TW/docs/CHEATSHEET.md +27 -6
- package/bundled/locales/zh-TW/docs/CLI-INIT-OPTIONS.md +29 -68
- package/bundled/locales/zh-TW/docs/FEATURE-REFERENCE.md +172 -24
- package/bundled/locales/zh-TW/docs/USAGE-MODES-COMPARISON.md +1 -2
- package/bundled/locales/zh-TW/integrations/google-antigravity/{INSTRUCTIONS.md → AGENTS.md} +1 -1
- package/bundled/locales/zh-TW/integrations/google-antigravity/README.md +3 -3
- package/bundled/locales/zh-TW/skills/adr-assistant/SKILL.md +1 -1
- package/bundled/locales/zh-TW/skills/agents/README.md +1 -1
- package/bundled/locales/zh-TW/skills/atdd-assistant/SKILL.md +2 -0
- package/bundled/locales/zh-TW/skills/bdd-assistant/SKILL.md +2 -0
- package/bundled/locales/zh-TW/skills/brainstorm-assistant/SKILL.md +22 -12
- package/bundled/locales/zh-TW/skills/brainstorm-assistant/guide.md +12 -9
- package/bundled/locales/zh-TW/skills/code-review-assistant/SKILL.md +1 -0
- package/bundled/locales/zh-TW/skills/commands/brainstorm.md +17 -13
- package/bundled/locales/zh-TW/skills/commands/config.md +0 -1
- package/bundled/locales/zh-TW/skills/commands/init.md +1 -2
- package/bundled/locales/zh-TW/skills/commit-standards/SKILL.md +2 -0
- package/bundled/locales/zh-TW/skills/contract-test-assistant/SKILL.md +2 -1
- package/bundled/locales/zh-TW/skills/dev-methodology/SKILL.md +2 -0
- package/bundled/locales/zh-TW/skills/dev-workflow-guide/SKILL.md +1 -1
- package/bundled/locales/zh-TW/skills/knowledge-graph/guide.md +2 -2
- package/bundled/locales/zh-TW/skills/migration-assistant/SKILL.md +1 -1
- package/bundled/locales/zh-TW/skills/observability-assistant/SKILL.md +1 -0
- package/bundled/locales/zh-TW/skills/project-discovery/SKILL.md +1 -0
- package/bundled/locales/zh-TW/skills/project-structure-guide/SKILL.md +1 -0
- package/bundled/locales/zh-TW/skills/release-standards/SKILL.md +3 -0
- package/bundled/locales/zh-TW/skills/requirement-assistant/SKILL.md +2 -0
- package/bundled/locales/zh-TW/skills/reverse-engineer/SKILL.md +3 -0
- package/bundled/locales/zh-TW/skills/reverse-engineer/tdd-analysis.md +13 -23
- package/bundled/locales/zh-TW/skills/runbook-assistant/SKILL.md +1 -0
- package/bundled/locales/zh-TW/skills/slo-assistant/SKILL.md +1 -0
- package/bundled/locales/zh-TW/skills/tdd-assistant/SKILL.md +2 -0
- package/bundled/locales/zh-TW/skills/workflows/README.md +2 -11
- package/bundled/skills/agents/README.md +1 -1
- package/bundled/skills/atdd-assistant/SKILL.md +2 -0
- package/bundled/skills/bdd-assistant/SKILL.md +2 -0
- package/bundled/skills/brainstorm-assistant/SKILL.md +31 -13
- package/bundled/skills/brainstorm-assistant/guide.md +9 -6
- package/bundled/skills/code-review-assistant/SKILL.md +1 -0
- package/bundled/skills/commands/brainstorm.md +12 -9
- package/bundled/skills/commands/config.md +0 -1
- package/bundled/skills/commands/init.md +2 -3
- package/bundled/skills/commit-standards/SKILL.md +2 -0
- package/bundled/skills/contract-test-assistant/SKILL.md +1 -0
- package/bundled/skills/dev-methodology/SKILL.md +4 -0
- package/bundled/skills/observability-assistant/SKILL.md +1 -0
- package/bundled/skills/project-discovery/SKILL.md +1 -0
- package/bundled/skills/project-structure-guide/SKILL.md +1 -0
- package/bundled/skills/release-standards/SKILL.md +3 -0
- package/bundled/skills/requirement-assistant/SKILL.md +2 -0
- package/bundled/skills/reverse-engineer/SKILL.md +3 -0
- package/bundled/skills/reverse-engineer/tdd-analysis.md +16 -23
- package/bundled/skills/runbook-assistant/SKILL.md +1 -0
- package/bundled/skills/slo-assistant/SKILL.md +1 -0
- package/bundled/skills/tdd-assistant/SKILL.md +2 -0
- package/bundled/skills/workflows/README.md +2 -11
- package/bundled/templates/.ai-context.yaml.template +194 -0
- package/bundled/templates/CLAUDE.md.template +145 -0
- package/bundled/templates/DESIGN.md +237 -0
- package/bundled/templates/SKILL-BRIEF-TEMPLATE.md +57 -0
- package/bundled/templates/SKILL-CANDIDATES.md +39 -0
- package/bundled/templates/gates/check-error-exit.mjs +309 -0
- package/bundled/templates/mcp-config.json +10 -0
- package/bundled/templates/methodology-template.yaml +209 -0
- package/bundled/templates/migration-template.md +408 -0
- package/bundled/templates/requirement-checklist.md +410 -0
- package/bundled/templates/requirement-document-template.md +591 -0
- package/bundled/templates/requirement-template.md +881 -0
- package/bundled/templates/reverse-spec-template.md +409 -0
- package/bundled/templates/test-case-template.md +74 -0
- package/bundled/templates/test-plan-template.md +74 -0
- package/package.json +9 -5
- package/src/commands/audit.js +82 -0
- package/src/commands/check.js +66 -10
- package/src/commands/init.js +161 -16
- package/src/commands/lint.js +96 -0
- package/src/commands/quickstart.js +16 -13
- package/src/commands/update.js +286 -14
- package/src/compilers/claude-code-compiler.js +4 -1
- package/src/config/ai-agent-paths.js +62 -17
- package/src/core/constants.js +42 -11
- package/src/core/manifest.js +201 -3
- package/src/core/paths.js +2 -2
- package/src/i18n/messages.js +9 -32
- package/src/installers/hooks-installer.js +167 -75
- package/src/installers/integration-installer.js +9 -5
- package/src/prompts/init.js +14 -14
- package/src/reconciler/actual-state-scanner.js +14 -3
- package/src/utils/detector.js +21 -1
- package/src/utils/effect-boundary.js +1093 -0
- package/src/utils/hasher.js +229 -9
- package/src/utils/hook-stats.js +1 -1
- package/src/utils/integration-generator.js +100 -4
- package/src/utils/reference-sync.js +4 -1
- package/src/utils/skills-installer.js +17 -3
- package/src/utils/spec-linter.js +35 -76
- package/src/utils/yaml-generator.js +51 -9
- package/standards-registry.json +31 -8
- package/src/commands/sync.js +0 -133
|
@@ -10,8 +10,8 @@ description: |
|
|
|
10
10
|
|
|
11
11
|
> **Language**: English | [繁體中文](../../locales/zh-TW/skills/brainstorm-assistant/guide.md)
|
|
12
12
|
|
|
13
|
-
**Version**: 4.
|
|
14
|
-
**Last Updated**: 2026-
|
|
13
|
+
**Version**: 4.2.0
|
|
14
|
+
**Last Updated**: 2026-08-21
|
|
15
15
|
**Applicability**: All software projects
|
|
16
16
|
**Scope**: universal
|
|
17
17
|
**Type**: Utility Skill (no core standard)
|
|
@@ -286,7 +286,7 @@ A single LLM is a weak, biased evaluator (Li et al., 2025: LLMs are strong at ge
|
|
|
286
286
|
| **User impact** | Impact 70% · Alignment 30% |
|
|
287
287
|
| **Strategic alignment** | Alignment 60% · Impact 40% |
|
|
288
288
|
|
|
289
|
-
**Per-criterion guide (1–5):**
|
|
289
|
+
**Per-criterion guide (1–5, reference format — not a script the critic must walk through):**
|
|
290
290
|
|
|
291
291
|
| Criterion | 5 | 3 | 1 |
|
|
292
292
|
|-----------|---|---|---|
|
|
@@ -312,7 +312,7 @@ A soft "please critique this" yields mostly agreement — LLMs are sycophantic u
|
|
|
312
312
|
- **Devil's Advocate**: "Your job is to argue this idea WILL fail. Produce 2 specific failure conditions."
|
|
313
313
|
- **Steelman**: "State the strongest, most charitable version of the counterargument — the one a thoughtful opponent would actually make."
|
|
314
314
|
|
|
315
|
-
|
|
315
|
+
Constraint: each counterargument must name a **specific context** and a **specific reason**. The sentence pattern **"This idea will fail in [specific context] because [specific reason]"** is a reference format, not a required phrasing (v4.2 — the critic brief is goal + constraints, see SKILL.md "Critic brief shape").
|
|
316
316
|
|
|
317
317
|
**NOT acceptable** (too vague): "This might be difficult." / "There could be edge cases."
|
|
318
318
|
|
|
@@ -348,6 +348,7 @@ Each idea that remains receives a badge: `✓ Passed rebuttal — [one-line summ
|
|
|
348
348
|
**Personas Used**: [domain expert, skeptic, analogist, ...]
|
|
349
349
|
**Lenses Used**: [analogical, reversal, ...]
|
|
350
350
|
**Pre-flight**: [Completed / Skipped] **Rebuttal**: [Completed / Skipped] **Tier**: [Baseline / Enhanced]
|
|
351
|
+
**Critic model level (D4 mind axis)**: [vendor-neutral level label per core/model-selection.md — naming a vendor model is a violation; not declared → D4 [degraded]]
|
|
351
352
|
|
|
352
353
|
## Problem Statement
|
|
353
354
|
[Refined problem + root cause from 5 Whys]
|
|
@@ -561,9 +562,9 @@ BQS v1 is an **additive quality contract**, not a rewrite. Everything from v3 is
|
|
|
561
562
|
|
|
562
563
|
- **All flags**: `--personas`, `--lens`, `--enhanced`, `--skip-preflight`, `--no-rebuttal`, `--quick`, `--technique` behave exactly as in v3. v4 adds one optional flag, `--intent`, for the Layer 0 declaration.
|
|
563
564
|
- **All mechanisms**: PRE-FLIGHT anti-anchoring, FRAME 5-Whys/HMW, the persona ensemble, diversity lenses, the multi-critic panel, the hard-role rebuttal (Devil's Advocate + Steelman), the Diversity-Collapse Guardrail, and the Enhanced Tier are unchanged.
|
|
564
|
-
- **The `--enhanced` isolated-agent host** is what
|
|
565
|
+
- **The `--enhanced` isolated-agent host** is what satisfies BQS **D4's seat axis** (judge ≠ generator); since v4.2 (XSPEC-388) a D4 pass additionally requires the review to declare its **model level** (mind axis — vendor-neutral labels per core/model-selection.md). On a baseline single context the panel is marked `[degraded]`, never silently passed.
|
|
565
566
|
|
|
566
|
-
BQS v1 是**疊加的品質契約**,不是打掉重練。v3 的一切都保留:所有旗標(`--personas`/`--lens`/`--enhanced`/`--skip-preflight`/`--no-rebuttal`/`--quick`/`--technique`)行為不變,v4 僅新增一個可選的 `--intent` 旗標供第 0 層宣告;所有機制(PRE-FLIGHT 防錨定、FRAME 5-Whys/HMW、persona 集成、多樣性透鏡、多評審面板、硬角色反駁、多樣性崩塌防護、Enhanced 層)不變;`--enhanced` 的隔離 agent
|
|
567
|
+
BQS v1 是**疊加的品質契約**,不是打掉重練。v3 的一切都保留:所有旗標(`--personas`/`--lens`/`--enhanced`/`--skip-preflight`/`--no-rebuttal`/`--quick`/`--technique`)行為不變,v4 僅新增一個可選的 `--intent` 旗標供第 0 層宣告;所有機制(PRE-FLIGHT 防錨定、FRAME 5-Whys/HMW、persona 集成、多樣性透鏡、多評審面板、硬角色反駁、多樣性崩塌防護、Enhanced 層)不變;`--enhanced` 的隔離 agent 宿主滿足的是 BQS **D4 的座位軸**(判官≠產生者),自 v4.2(XSPEC-388)起 D4 pass 另需評審宣告**模型層級**(心智軸——依 core/model-selection.md 的廠商中立標籤),baseline 單 context 標 `[degraded]`、不靜默通過。
|
|
567
568
|
|
|
568
569
|
---
|
|
569
570
|
|
|
@@ -598,6 +599,7 @@ BQS v1 是**疊加的品質契約**,不是打掉重練。v3 的一切都保留
|
|
|
598
599
|
| [Requirement Engineering](../../core/requirement-engineering.md) | Brainstorm output feeds requirement writing |
|
|
599
600
|
| [Spec-Driven Development](../../core/spec-driven-development.md) | Brainstorm output feeds SDD proposals |
|
|
600
601
|
| [Anti-Hallucination](../../core/anti-hallucination.md) | Critic feasibility claims must be evidence-based, not asserted |
|
|
602
|
+
| [Model Selection](../../core/model-selection.md) | The D4 mind axis (declared model level) and the divergence-side level (Standard or higher) defer to this standard's criteria — cited, never restated |
|
|
601
603
|
|
|
602
604
|
---
|
|
603
605
|
|
|
@@ -605,6 +607,7 @@ BQS v1 是**疊加的品質契約**,不是打掉重練。v3 的一切都保留
|
|
|
605
607
|
|
|
606
608
|
| Version | Date | Changes |
|
|
607
609
|
|---------|------|---------|
|
|
610
|
+
| 4.2.0 | 2026-08-21 | XSPEC-388: D4's pass condition gains a second axis — the seat (independent context, unchanged) plus the mind (the review must declare its required **model level**, expressed only with the vendor-neutral labels of core/model-selection.md; naming a concrete vendor model is a violation; missing declaration → `[degraded]`, never pass). CONVERGE critic briefs re-shaped as goal + constraints per MS-009: D5–D8 presented as criteria the judgment must satisfy, never as an ordered procedure; the fixed rebuttal sentence pattern, per-criterion 1–5 guides, and critic weight formulas are kept as reference formats, not mandatory steps. Divergence side cites MS-004/Criterion 2 (Standard or higher — deliberately not "highest"), validated through the calibration loop's existing Diversity (D2/D3) lagging column. Terminology: the model-capability axis is written "model level" throughout, because "tier" is already taken by BQS tiering and the Enhanced Tier. All v3 flags and mechanisms preserved. |
|
|
608
611
|
| 4.1.0 | 2026-07-09 | XSPEC-325: Replaced the fixed Top-3 recommendation cap with a score-threshold **Recommended Set** (Agg. Score ≥ 3.5, uncapped in count) throughout BQS Layer 2 — the product gate (D5–D8), the hard-role rebuttal round (Devil's Advocate + Steelman), the Meta stop rule (set-membership stability), the Diversity-Collapse Guardrail, and the OUTPUT Recommendations block all now key off the Recommended Set instead of a fixed 3. If no idea reaches 3.5, the single highest-scoring idea is still shown, marked "below threshold — shown for reference", so the report is never empty. |
|
|
609
612
|
| 4.0.0 | 2026-06-22 | XSPEC-296: Brainstorm Quality Standard (BQS v1) — a four-layer × timeline quality contract layered additively on v3. Layer 0 explore/exploit intent (modulates D2 weight); Layer 1 process leading dimensions D1–D4 with a hard sequence gate (D5–D8 forbidden during divergence); Layer 2 product leading dimensions D5–D8 applied to Top 3 only, with a Seeds column and high-variance contested zone; Layer 3 Judgment Override (overrides aggregate score). D4 judge≠generator (independent context else `[degraded]`); D5 claim split (external-fact floor cross-tier); D7 two-state falsifiability ("need to do X" → next-step, not fail); Meta stop rule (Top-3 set stability + hard cap 2 rounds). Session Self-Evaluation re-positioned as the calibration loop's lagging end (Adoption→D6, Diversity→D2/D3, Cognitive Load→cost; two parallel evaluations forbidden). First principle refined to "decisions use leading, calibration uses lagging". Tiering bound to objective Mode Selection triggers. New flag `--intent`. All v3 flags/mechanisms preserved. |
|
|
610
613
|
| 3.0.0 | 2026-06-01 | XSPEC-247: DIVERGE re-centred on persona ensemble + diversity lenses (analogical/reversal/morphological); CONVERGE re-centred on multi-critic panel + hard-role rebuttal (Devil's Advocate + Steelman); Diversity-Collapse Guardrail; Enhanced Tier (parallel persona/critic agents, graceful fallback); Research Foundations rebuilt on 6 verified 2024–2026 sources; Validity Caveats re-rated (pre-flight LOW, Nijstad/Nemeth demoted); new flags `--personas`/`--lens`/`--enhanced`; anti-seed guardrail |
|
|
@@ -82,6 +82,7 @@ After `/code-review` completes, the AI assistant should suggest:
|
|
|
82
82
|
|
|
83
83
|
## Reference | 參考
|
|
84
84
|
|
|
85
|
+
- [Pre-Commit Checklist](./checkin-checklist.md) — Read it before committing, as the pre-commit pass.
|
|
85
86
|
- Detailed guide: [guide.md](./guide.md)
|
|
86
87
|
- Core standard: [code-review-checklist.md](../../core/code-review-checklist.md)
|
|
87
88
|
|
|
@@ -28,7 +28,7 @@ PRE-FLIGHT ──► FRAME ──► DIVERGE ──────────► C
|
|
|
28
28
|
| **PRE-FLIGHT** | Prevent AI anchoring | User writes 3 ideas first; no analogy seed; **BQS Layer 0 intent (explore/exploit)** | 防止錨定 |
|
|
29
29
|
| **FRAME** | Define problem clearly | 5 Whys, HMW, Stakeholder Map; **D1 frame purity** | 清楚定義問題 |
|
|
30
30
|
| **DIVERGE** | Force viewpoint diversity | Persona ensemble + diversity lenses; **BQS Layer 1 D1–D4, hard gate hides D5–D8** | 逼出視角多樣性 |
|
|
31
|
-
| **CONVERGE** | Bias-checked selection | Multi-critic panel + Devil's Advocate/Steelman; **BQS Layer 2 D5–D8 on
|
|
31
|
+
| **CONVERGE** | Bias-checked selection | Multi-critic panel + Devil's Advocate/Steelman; **BQS Layer 2 D5–D8 on the Recommended Set (Agg. ≥ 3.5), D4 judge≠generator (two axes: independent context + declared model level)** | 降偏誤選擇 |
|
|
32
32
|
| **OUTPUT** | Actionable report | Brainstorm Report + Seeds + Contested Zone + **Layer 3 Judgment Override** | 可執行的報告 |
|
|
33
33
|
|
|
34
34
|
> **BQS v1 (XSPEC-296):** v4 layers a four-layer × timeline quality contract on v3. Full oracles and structural rules are in the skill — see [Brainstorm Assistant Skill](../brainstorm-assistant/SKILL.md#bqs-v1--quality-contract--bqs-v1--品質契約).
|
|
@@ -64,7 +64,7 @@ PRE-FLIGHT ──► FRAME ──► DIVERGE ──────────► C
|
|
|
64
64
|
## Problem Statement
|
|
65
65
|
[Refined problem from FRAME phase]
|
|
66
66
|
|
|
67
|
-
##
|
|
67
|
+
## Recommendations (Agg. Score ≥ 3.5 — uncapped)
|
|
68
68
|
1. **[Idea]** — Agg. X.X ✓ Passed rebuttal — Persona: [..] — [Why recommended]
|
|
69
69
|
|
|
70
70
|
## Diversity Note
|
|
@@ -96,7 +96,7 @@ After brainstorming, the typical workflow is:
|
|
|
96
96
|
| `/brainstorm "topic"` | 以指定主題啟動 PRE-FLIGHT,再進入 FRAME |
|
|
97
97
|
| `/brainstorm --personas "a,b,c"` | 以自訂 persona 組進入 DIVERGE |
|
|
98
98
|
| `/brainstorm --lens <name>` | 以指定多樣性透鏡為主進入 DIVERGE |
|
|
99
|
-
| `/brainstorm --enhanced` | 若宿主支援子代理則平行跑 persona/評審,否則靜默退回 baseline
|
|
99
|
+
| `/brainstorm --enhanced` | 若宿主支援子代理則平行跑 persona/評審,否則靜默退回 baseline;此模式滿足 BQS D4 的座位軸(獨立 context),pass 另需宣告模型層級(心智軸,見 skill D4) |
|
|
100
100
|
| `/brainstorm --intent exploit` | 以 exploit 意圖啟動(BQS Layer 0),D2 低覆蓋不扣分 |
|
|
101
101
|
|
|
102
102
|
### Interaction Script | 互動腳本
|
|
@@ -121,12 +121,13 @@ After brainstorming, the typical workflow is:
|
|
|
121
121
|
3. 至少套用一個多樣性透鏡(類比/假設反轉/形態矩陣)
|
|
122
122
|
4. 以多樣性(覆蓋的 persona/透鏡數,D2/D3)而非數量為繼續門檻
|
|
123
123
|
5. **硬序列閘**:D5–D8 在最後一個 persona 產完前**不得揭示或評分**;CONVERGE critic 不得提前呼叫
|
|
124
|
+
6. **模型層級(發散側)**:以 **Standard 或更高**層級執行——依 core/model-selection.md 的 MS-004/Criterion 2(引用,不複述;不是「最高層級」)
|
|
124
125
|
|
|
125
|
-
#### CONVERGE Phase (BQS Layer 2 — D5–D8 on
|
|
126
|
-
1. 以 3
|
|
127
|
-
2.
|
|
128
|
-
3.
|
|
129
|
-
4. **Meta
|
|
126
|
+
#### CONVERGE Phase (BQS Layer 2 — D5–D8 on the Recommended Set only)
|
|
127
|
+
1. 以 3 個獨立評審(工程可行性/使用者影響/策略一致)各自評分後聚合;**評審提示以「目標+約束」表達**(判準,不是步驟清單——理由見 skill 引用的 core/model-selection.md MS-009),加權公式與逐準則指南為參考格式
|
|
128
|
+
2. 對**推薦集**(Agg. Score ≥ 3.5,不限筆數)跑硬角色 Devil's Advocate(論證會失敗)+ Steelman;使用者以 (a)修改/(b)反駁/(c)移除 回應。**D4 判官≠產生者,兩軸**:(1) 評審在獨立 context(`--enhanced`)執行,且 (2) 宣告模型層級(core/model-selection.md 的廠商中立標籤;指名具體廠商模型即違規)——缺任一軸標 `[degraded]` 不得 pass
|
|
129
|
+
3. **僅對推薦集**套用 D5 接地(外部事實需 file:line/來源、跨級地板;假說免接地)、D6 淨值(解誰問題/真有嗎/不做代價+掛 lagging 欄)、D7 二態證偽(「需先做 X」轉 next-step、不算 fail)、D8 next-step 裁決——四者為判準、不限順序
|
|
130
|
+
4. **Meta 停止規則**:維度全綠且再跑一輪推薦集集合成員不變→停;硬上限 2 輪
|
|
130
131
|
|
|
131
132
|
🛑 **STOP**: 展示 Brainstorm Report(含 Seeds/爭議區/Judgment Override)後等待使用者決定下一步
|
|
132
133
|
|
|
@@ -147,13 +148,15 @@ After brainstorming, the typical workflow is:
|
|
|
147
148
|
| 使用「像 X 但給 Y」種子 | 改寫為底層問題再繼續(反種子 guardrail) |
|
|
148
149
|
| 指定的 persona/透鏡不存在 | 列出可用選項供選擇 |
|
|
149
150
|
| `--enhanced` 但宿主不支援子代理 | 靜默退回 baseline,照常進行 |
|
|
150
|
-
|
|
|
151
|
+
| 推薦集全來自同一 persona/透鏡 | 標示並在輸出前再跑一個透鏡 |
|
|
151
152
|
| baseline 單 context 跑評審(無獨立 context) | BQS D4 標 `[degraded]`,不得標 pass |
|
|
153
|
+
| 評審未宣告模型層級(或以具體廠商模型名宣告) | BQS D4 標 `[degraded]` 不得 pass;模型名改為 core/model-selection.md 的層級標籤 |
|
|
152
154
|
| 外部事實宣稱無 file:line/來源 | D5 接地 fail,要求補來源或改標 `[假說]` |
|
|
153
155
|
|
|
154
156
|
## References | 參考
|
|
155
157
|
|
|
156
158
|
* [Brainstorm Assistant Skill](../brainstorm-assistant/SKILL.md)
|
|
157
159
|
* [Brainstorm Assistant Guide](../brainstorm-assistant/guide.md)
|
|
160
|
+
* [Model Selection](../../core/model-selection.md) — model-level labels for BQS D4 and the divergence side (cited, not restated)
|
|
158
161
|
* [Requirement Assistant](../requirement-assistant/SKILL.md)
|
|
159
162
|
* [Spec-Driven Development](../spec-driven-dev/SKILL.md)
|
|
@@ -170,7 +170,6 @@ Supported tools for Commands:
|
|
|
170
170
|
| Mode | Description | 說明 |
|
|
171
171
|
|------|-------------|------|
|
|
172
172
|
| `standard` | Summary + task mapping, AI knows when to read which standard (Recommended) | 摘要 + 任務映射(推薦)|
|
|
173
|
-
| `full` | Embed all standards in integration files | 完整內嵌所有標準 |
|
|
174
173
|
| `minimal` | Only core rules embedded | 僅內嵌核心規則 |
|
|
175
174
|
|
|
176
175
|
## Effects of Configuration Changes | 設定變更的影響
|
|
@@ -41,7 +41,7 @@ Use AskUserQuestion with multiSelect to ask which AI tools to configure:
|
|
|
41
41
|
| **OpenCode** | `AGENTS.md` | ✅ | ✅ |
|
|
42
42
|
| **Gemini CLI** | `GEMINI.md` | ✅ | ✅ |
|
|
43
43
|
| **Codex** | `AGENTS.md` | ✅ | ❌ |
|
|
44
|
-
| **Antigravity** |
|
|
44
|
+
| **Antigravity** | `.agents/AGENTS.md` | ✅ | ❌ |
|
|
45
45
|
|
|
46
46
|
Pre-select tools detected in the environment. Note: Codex and OpenCode share `AGENTS.md`.
|
|
47
47
|
|
|
@@ -226,7 +226,6 @@ Use AskUserQuestion for integration file content:
|
|
|
226
226
|
| Option | Description |
|
|
227
227
|
|--------|-------------|
|
|
228
228
|
| **Standard (Recommended)** | Summary + task mapping, AI knows when to read which standard |
|
|
229
|
-
| **Full Embed** | Embed all rules, AI can use immediately but larger file |
|
|
230
229
|
| **Minimal** | File references only, best with Skills |
|
|
231
230
|
|
|
232
231
|
### Step 13: Confirm and Execute | 步驟 13:確認並執行
|
|
@@ -312,7 +311,7 @@ See `uds init --help` for all options.
|
|
|
312
311
|
9. **語言擴展** — 偵測到語言時詢問
|
|
313
312
|
10. **框架擴展** — 偵測到框架時詢問
|
|
314
313
|
11. **地區設定** — English / Traditional Chinese
|
|
315
|
-
12. **內容模式** — Standard /
|
|
314
|
+
12. **內容模式** — Standard / Minimal
|
|
316
315
|
13. **確認並執行** — 展示摘要,確認後一次執行所有安裝
|
|
317
316
|
|
|
318
317
|
**IMPORTANT**: AskUserQuestion 最多 4 個選項。3+ 工具時必須使用 Smart Grouping 兩階段策略。
|
|
@@ -147,6 +147,8 @@ After `/commit` completes, the AI assistant should suggest:
|
|
|
147
147
|
|
|
148
148
|
## Reference | 參考
|
|
149
149
|
|
|
150
|
+
- [Conventional Commits Guide](./conventional-commits.md) — Read it when you need the exact type, scope and format rules.
|
|
151
|
+
- [Output Language Options](./language-options.md) — Read it when deciding which language a commit message is written in.
|
|
150
152
|
- Detailed guide: [guide.md](./guide.md)
|
|
151
153
|
- Core standard: [commit-message-guide.md](../../core/commit-message-guide.md)
|
|
152
154
|
|
|
@@ -111,6 +111,7 @@ After `/contract-test` completes:
|
|
|
111
111
|
|
|
112
112
|
## Reference | 參考
|
|
113
113
|
|
|
114
|
+
- Detailed guide: [guide.md](./guide.md) — contract testing strategy and setup. Read it when configuring Pact/OpenAPI or wiring contract tests into CI.
|
|
114
115
|
- Detailed guide: [contract-testing.md](../../options/testing/contract-testing.md)
|
|
115
116
|
- Related: [api-design-assistant](../api-design-assistant/SKILL.md)
|
|
116
117
|
|
|
@@ -101,6 +101,10 @@ After `/methodology` completes, the AI assistant should suggest based on the sel
|
|
|
101
101
|
|
|
102
102
|
## Reference | 參考
|
|
103
103
|
|
|
104
|
+
- [Create Custom Methodology Guide](./create-methodology.md) — Read it when building a custom methodology rather than using a shipped one.
|
|
105
|
+
- [Integrated Development Flow Guide](./integrated-flow.md) — Read it when combining several methodologies into one flow.
|
|
106
|
+
- [Workflow Prerequisite Checking / 工作流前置步驟檢查](./prerequisite-check.md) — Read it when a workflow step needs its prerequisites checked first.
|
|
107
|
+
- [Methodology Runtime Guide](./runtime.md) — Read it when you need to know how a methodology behaves while it runs.
|
|
104
108
|
- Detailed guide: [guide.md](./guide.md)
|
|
105
109
|
|
|
106
110
|
|
|
@@ -121,6 +121,7 @@ Before deploying a service to production:
|
|
|
121
121
|
|
|
122
122
|
## Reference | 參考
|
|
123
123
|
|
|
124
|
+
- Detailed guide: [guide.md](./guide.md) — the three pillars (logs, metrics, traces) in depth. Read it when setting up monitoring, choosing metric types, implementing tracing, or assessing maturity.
|
|
124
125
|
- Core standard: [observability-standards.md](../../core/observability-standards.md)
|
|
125
126
|
- Core standard: [alerting-standards.md](../../core/alerting-standards.md)
|
|
126
127
|
- Core standard: [slo-standards.md](../../core/slo-standards.md)
|
|
@@ -147,6 +147,7 @@ After `/discover` completes, the AI assistant should suggest based on the assess
|
|
|
147
147
|
|
|
148
148
|
## Reference | 參考
|
|
149
149
|
|
|
150
|
+
- Step-by-step workflow: [workflow.md](./workflow.md) — the discovery steps in order (code health, architecture, documentation inventory, review snapshot, dependency and security). Read it when actually running a discovery rather than deciding whether to.
|
|
150
151
|
- Detailed guide: [guide.md](./guide.md)
|
|
151
152
|
|
|
152
153
|
|
|
@@ -168,6 +168,7 @@ After `/project-structure` completes, the AI assistant should suggest:
|
|
|
168
168
|
|
|
169
169
|
## Related Standards
|
|
170
170
|
|
|
171
|
+
- [Language-specific patterns](./language-patterns.md) — concrete directory layouts per language (Node.js/TypeScript, Python, Go, and others). Read it when laying out a project in a specific language.
|
|
171
172
|
- [Core: Project Structure](../../core/project-structure.md)
|
|
172
173
|
- [Core: Documentation Structure](../../core/documentation-structure.md)
|
|
173
174
|
- [Guide: File Placement Decision Guide](../../core/guides/file-placement-guide.md)
|
|
@@ -132,6 +132,9 @@ After `/release` completes, the AI assistant should suggest:
|
|
|
132
132
|
|
|
133
133
|
## Reference | 參考
|
|
134
134
|
|
|
135
|
+
- [Changelog Format Guide](./changelog-format.md) — Read it when writing or reviewing a changelog entry.
|
|
136
|
+
- [Release Workflow Guide](./release-workflow.md) — Read it when actually cutting a release, step by step.
|
|
137
|
+
- [Semantic Versioning Guide](./semantic-versioning.md) — Read it when deciding whether a change is major, minor or patch.
|
|
135
138
|
- Detailed guide: [guide.md](./guide.md)
|
|
136
139
|
- Core standard: [versioning.md](../../core/versioning.md)
|
|
137
140
|
|
|
@@ -75,6 +75,8 @@ After `/requirement` completes, the AI assistant should suggest:
|
|
|
75
75
|
|
|
76
76
|
## Reference | 參考
|
|
77
77
|
|
|
78
|
+
- [Requirement Completeness Checklist](./requirement-checklist.md) — Read it when checking a requirement is complete before it is accepted.
|
|
79
|
+
- [Requirement Writing Guide](./requirement-writing.md) — Read it when writing a requirement from scratch.
|
|
78
80
|
- Detailed guide: [guide.md](./guide.md)
|
|
79
81
|
- Core standard: [requirement-engineering.md](../../core/requirement-engineering.md)
|
|
80
82
|
|
|
@@ -147,6 +147,9 @@ After `/reverse` (full or `spec`) completes, the AI assistant should suggest:
|
|
|
147
147
|
|
|
148
148
|
## Reference | 參考
|
|
149
149
|
|
|
150
|
+
- [BDD Extraction Workflow Guide](./bdd-extraction.md) — Read it when extracting BDD scenarios out of an existing spec.
|
|
151
|
+
- [TDD Analysis Workflow Guide](./tdd-analysis.md) — Read it when analysing test coverage against scenarios and finding the gaps.
|
|
152
|
+
- Step-by-step workflow: [workflow.md](./workflow.md) — the reverse-engineering phases in order (code scanning, data models, configuration, test analysis, coverage). Read it when actually running the process rather than deciding whether to.
|
|
150
153
|
- Detailed guide: [guide.md](./guide.md)
|
|
151
154
|
- Core standard: [reverse-engineering-standards.md](../../core/reverse-engineering-standards.md)
|
|
152
155
|
|
|
@@ -597,9 +597,22 @@ Mark both scenarios as [Inferred] with shared test reference
|
|
|
597
597
|
|
|
598
598
|
## CI/CD Integration
|
|
599
599
|
|
|
600
|
-
### GitHub Actions
|
|
600
|
+
### GitHub Actions — not currently scriptable
|
|
601
|
+
|
|
602
|
+
There is no `uds reverse-tdd` CLI command. Coverage-gap analysis is delivered
|
|
603
|
+
as the **`reverse-tdd`** AI agent (`uds agent install reverse-tdd`) — an
|
|
604
|
+
interactive, LLM-driven analysis run from your AI tool, not a deterministic
|
|
605
|
+
script that emits a `coverage.json` file. A prior version of this doc showed
|
|
606
|
+
a GitHub Actions step invoking a CLI command that never existed (XSPEC-383
|
|
607
|
+
R4, 2026-08-19).
|
|
608
|
+
|
|
609
|
+
The sketch below is **illustrative only** — it shows the shape a scriptable
|
|
610
|
+
CI integration would need if one is built, not something you can paste into
|
|
611
|
+
a workflow today:
|
|
601
612
|
|
|
602
613
|
```yaml
|
|
614
|
+
# ASPIRATIONAL — no scriptable equivalent exists yet.
|
|
615
|
+
# Today: run the reverse-tdd agent interactively from your AI tool instead.
|
|
603
616
|
name: BDD Coverage Check
|
|
604
617
|
|
|
605
618
|
on: [pull_request]
|
|
@@ -610,29 +623,9 @@ jobs:
|
|
|
610
623
|
steps:
|
|
611
624
|
- uses: actions/checkout@v4
|
|
612
625
|
|
|
613
|
-
- name: Run BDD Coverage Analysis
|
|
614
|
-
run: |
|
|
615
|
-
uds reverse-tdd features/ --output coverage.json
|
|
616
|
-
|
|
617
|
-
- name: Check Coverage Threshold
|
|
626
|
+
- name: Run BDD Coverage Analysis (not yet implemented)
|
|
618
627
|
run: |
|
|
619
|
-
|
|
620
|
-
if (( $(echo "$COVERAGE < 0.80" | bc -l) )); then
|
|
621
|
-
echo "Coverage $COVERAGE below 80% threshold"
|
|
622
|
-
exit 1
|
|
623
|
-
fi
|
|
624
|
-
|
|
625
|
-
- name: Comment on PR
|
|
626
|
-
uses: actions/github-script@v6
|
|
627
|
-
with:
|
|
628
|
-
script: |
|
|
629
|
-
const coverage = require('./coverage.json');
|
|
630
|
-
github.rest.issues.createComment({
|
|
631
|
-
issue_number: context.issue.number,
|
|
632
|
-
owner: context.repo.owner,
|
|
633
|
-
repo: context.repo.repo,
|
|
634
|
-
body: `## BDD Coverage Report\n\nCoverage: ${(coverage.summary.effectiveCoverage * 100).toFixed(1)}%`
|
|
635
|
-
});
|
|
628
|
+
echo "No CLI equivalent yet — see reverse-tdd agent for interactive use"
|
|
636
629
|
```
|
|
637
630
|
|
|
638
631
|
---
|
|
@@ -52,6 +52,7 @@ Any deploy runbook that includes a destructive-update pattern (stop → swap →
|
|
|
52
52
|
|
|
53
53
|
## Reference | 參考
|
|
54
54
|
|
|
55
|
+
- Detailed guide: [guide.md](./guide.md) — runbook creation, organization and validation. Read it when writing runbooks, reviewing operational procedures, planning drills, or assessing coverage.
|
|
55
56
|
- Core standard: [runbook-standards.md](../../core/runbook-standards.md)
|
|
56
57
|
- Related: [alerting-standards.md](../../core/alerting-standards.md)
|
|
57
58
|
- Related: [postmortem-standards.md](../../core/postmortem-standards.md)
|
|
@@ -46,6 +46,7 @@ Guide SLI selection, SLO setting methodology, and Error Budget management.
|
|
|
46
46
|
|
|
47
47
|
## Reference | 參考
|
|
48
48
|
|
|
49
|
+
- Detailed guide: [guide.md](./guide.md) — SLI/SLO/error-budget definition and management. Read it when defining SLOs, selecting SLIs, calculating error budgets, or setting reliability targets.
|
|
49
50
|
- Core standard: [slo-standards.md](../../core/slo-standards.md)
|
|
50
51
|
- Related: [observability-standards.md](../../core/observability-standards.md)
|
|
51
52
|
- Related: [alerting-standards.md](../../core/alerting-standards.md)
|
|
@@ -87,6 +87,8 @@ After `/tdd` completes, the AI assistant should suggest:
|
|
|
87
87
|
|
|
88
88
|
## Reference | 參考
|
|
89
89
|
|
|
90
|
+
- [TDD Language Examples](./language-examples.md) — Read it when you need a concrete example in a specific language.
|
|
91
|
+
- [TDD Workflow Guide](./tdd-workflow.md) — Read it when running the red-green-refactor cycle end to end.
|
|
90
92
|
- Detailed guide: [guide.md](./guide.md)
|
|
91
93
|
- Core standard: [test-driven-development.md](../../core/test-driven-development.md)
|
|
92
94
|
|
|
@@ -157,18 +157,9 @@ steps:
|
|
|
157
157
|
|
|
158
158
|
## Usage
|
|
159
159
|
|
|
160
|
-
###
|
|
160
|
+
### Getting Workflows
|
|
161
161
|
|
|
162
|
-
|
|
163
|
-
# List available workflows
|
|
164
|
-
uds workflow list
|
|
165
|
-
|
|
166
|
-
# Install specific workflow
|
|
167
|
-
uds workflow install integrated-flow
|
|
168
|
-
|
|
169
|
-
# Install all workflows
|
|
170
|
-
uds workflow install --all
|
|
171
|
-
```
|
|
162
|
+
`uds workflow` was removed in v6.0.0 (process orchestration moved to the adoption layer — DEC-049; see [MIGRATION-v6.md §3](../../docs/MIGRATION-v6.md#3-removed-4-deprecated-cli-commands)). There is no CLI install step: workflow definitions live directly under `skills/workflows/*.workflow.yaml` in this repo (see the table above), so reference them by path or copy them into your project's `.claude/workflows/`.
|
|
172
163
|
|
|
173
164
|
### Execution
|
|
174
165
|
|
|
@@ -0,0 +1,194 @@
|
|
|
1
|
+
# ============================================================
|
|
2
|
+
# .ai-context.yaml - AI Context Configuration Template
|
|
3
|
+
# ============================================================
|
|
4
|
+
#
|
|
5
|
+
# This file helps AI assistants understand your project structure
|
|
6
|
+
# and optimize their analysis and code generation.
|
|
7
|
+
#
|
|
8
|
+
# Usage:
|
|
9
|
+
# 1. Copy this file to your project root as `.ai-context.yaml`
|
|
10
|
+
# 2. Customize the values for your project
|
|
11
|
+
# 3. AI tools will use this for better context management
|
|
12
|
+
#
|
|
13
|
+
# Reference: core/ai-friendly-architecture.md
|
|
14
|
+
# ============================================================
|
|
15
|
+
|
|
16
|
+
version: 1.0.0
|
|
17
|
+
|
|
18
|
+
# ============================================================
|
|
19
|
+
# PROJECT INFORMATION
|
|
20
|
+
# ============================================================
|
|
21
|
+
project:
|
|
22
|
+
# Project name (should match package.json or pyproject.toml)
|
|
23
|
+
name: my-project
|
|
24
|
+
|
|
25
|
+
# Project type affects analysis strategy
|
|
26
|
+
# Options: web-app | library | cli | api | monorepo | mobile
|
|
27
|
+
type: web-app
|
|
28
|
+
|
|
29
|
+
# Primary programming language
|
|
30
|
+
# Options: typescript | javascript | python | go | rust | java | other
|
|
31
|
+
primary-language: typescript
|
|
32
|
+
|
|
33
|
+
# Brief description for AI context
|
|
34
|
+
description: |
|
|
35
|
+
A brief description of what this project does.
|
|
36
|
+
Include key features and architectural decisions.
|
|
37
|
+
|
|
38
|
+
# ============================================================
|
|
39
|
+
# MODULE DEFINITIONS
|
|
40
|
+
# ============================================================
|
|
41
|
+
# Define logical modules in your codebase for structured analysis.
|
|
42
|
+
# AI will use these boundaries to chunk large codebases efficiently.
|
|
43
|
+
|
|
44
|
+
modules:
|
|
45
|
+
# Example: Authentication module
|
|
46
|
+
- name: auth
|
|
47
|
+
path: src/auth/
|
|
48
|
+
entry: index.ts
|
|
49
|
+
description: User authentication and session management
|
|
50
|
+
dependencies:
|
|
51
|
+
- database
|
|
52
|
+
- crypto
|
|
53
|
+
# Priority affects analysis order (high | medium | low)
|
|
54
|
+
priority: high
|
|
55
|
+
|
|
56
|
+
# Example: API module
|
|
57
|
+
- name: api
|
|
58
|
+
path: src/api/
|
|
59
|
+
entry: routes.ts
|
|
60
|
+
description: REST API endpoints and handlers
|
|
61
|
+
dependencies:
|
|
62
|
+
- auth
|
|
63
|
+
- database
|
|
64
|
+
priority: high
|
|
65
|
+
|
|
66
|
+
# Example: Database module
|
|
67
|
+
- name: database
|
|
68
|
+
path: src/db/
|
|
69
|
+
entry: index.ts
|
|
70
|
+
description: Database connection and models
|
|
71
|
+
dependencies: []
|
|
72
|
+
priority: high
|
|
73
|
+
|
|
74
|
+
# Example: Utilities module
|
|
75
|
+
- name: utils
|
|
76
|
+
path: src/utils/
|
|
77
|
+
entry: index.ts
|
|
78
|
+
description: Shared utility functions
|
|
79
|
+
dependencies: []
|
|
80
|
+
priority: low
|
|
81
|
+
|
|
82
|
+
# ============================================================
|
|
83
|
+
# ANALYSIS HINTS
|
|
84
|
+
# ============================================================
|
|
85
|
+
# Guide AI tools on how to analyze this project
|
|
86
|
+
|
|
87
|
+
analysis-hints:
|
|
88
|
+
# Main entry points - AI starts analysis here
|
|
89
|
+
entry-points:
|
|
90
|
+
- src/main.ts
|
|
91
|
+
- src/index.ts
|
|
92
|
+
|
|
93
|
+
# Patterns to ignore during analysis
|
|
94
|
+
ignore-patterns:
|
|
95
|
+
- node_modules
|
|
96
|
+
- dist
|
|
97
|
+
- build
|
|
98
|
+
- coverage
|
|
99
|
+
- "*.test.ts"
|
|
100
|
+
- "*.spec.ts"
|
|
101
|
+
- __pycache__
|
|
102
|
+
- .venv
|
|
103
|
+
|
|
104
|
+
# Architecture type affects analysis approach
|
|
105
|
+
# Options: layered | microservices | modular | monolith | event-driven
|
|
106
|
+
architecture-type: layered
|
|
107
|
+
|
|
108
|
+
# Key configuration files to understand project setup
|
|
109
|
+
config-files:
|
|
110
|
+
- package.json
|
|
111
|
+
- tsconfig.json
|
|
112
|
+
- .env.example
|
|
113
|
+
|
|
114
|
+
# ============================================================
|
|
115
|
+
# DOCUMENTATION REFERENCES
|
|
116
|
+
# ============================================================
|
|
117
|
+
# Point AI to different documentation layers
|
|
118
|
+
|
|
119
|
+
documentation:
|
|
120
|
+
# Level 1: Quick reference (< 500 tokens)
|
|
121
|
+
quick-ref: docs/QUICK-REF.md
|
|
122
|
+
|
|
123
|
+
# Level 2: Detailed architecture (< 5000 tokens)
|
|
124
|
+
detailed: docs/ARCHITECTURE.md
|
|
125
|
+
|
|
126
|
+
# Level 3: Full examples
|
|
127
|
+
examples: docs/examples/
|
|
128
|
+
|
|
129
|
+
# API documentation
|
|
130
|
+
api-docs: docs/api/
|
|
131
|
+
|
|
132
|
+
# Changelog for understanding recent changes
|
|
133
|
+
changelog: CHANGELOG.md
|
|
134
|
+
|
|
135
|
+
# ============================================================
|
|
136
|
+
# RLM CONTEXT STRATEGY
|
|
137
|
+
# ============================================================
|
|
138
|
+
# Configuration for handling large codebases with AI
|
|
139
|
+
|
|
140
|
+
context-strategy:
|
|
141
|
+
# Maximum tokens per analysis chunk
|
|
142
|
+
max-chunk-size: 50000
|
|
143
|
+
|
|
144
|
+
# Token overlap between chunks for context continuity
|
|
145
|
+
overlap: 500
|
|
146
|
+
|
|
147
|
+
# Analysis pattern
|
|
148
|
+
# Options: hierarchical | parallel | sequential
|
|
149
|
+
analysis-pattern: hierarchical
|
|
150
|
+
|
|
151
|
+
# Enable RLM-aware processing
|
|
152
|
+
enable-rlm: true
|
|
153
|
+
|
|
154
|
+
# ============================================================
|
|
155
|
+
# CUSTOM ANNOTATIONS
|
|
156
|
+
# ============================================================
|
|
157
|
+
# Define project-specific code annotation patterns
|
|
158
|
+
|
|
159
|
+
annotations:
|
|
160
|
+
# Security-related code markers
|
|
161
|
+
security:
|
|
162
|
+
- "@ai-security"
|
|
163
|
+
- "@security-critical"
|
|
164
|
+
|
|
165
|
+
# Performance-critical code markers
|
|
166
|
+
performance:
|
|
167
|
+
- "@ai-performance"
|
|
168
|
+
- "@perf-critical"
|
|
169
|
+
|
|
170
|
+
# Complexity hints
|
|
171
|
+
complexity:
|
|
172
|
+
- "@ai-complexity"
|
|
173
|
+
|
|
174
|
+
# ============================================================
|
|
175
|
+
# TEAM CONVENTIONS
|
|
176
|
+
# ============================================================
|
|
177
|
+
# Help AI understand your team's conventions
|
|
178
|
+
|
|
179
|
+
conventions:
|
|
180
|
+
# Naming conventions
|
|
181
|
+
naming:
|
|
182
|
+
files: kebab-case # kebab-case | camelCase | snake_case | PascalCase
|
|
183
|
+
functions: camelCase
|
|
184
|
+
classes: PascalCase
|
|
185
|
+
constants: UPPER_SNAKE
|
|
186
|
+
|
|
187
|
+
# Code style
|
|
188
|
+
style:
|
|
189
|
+
indent: 2
|
|
190
|
+
quotes: single
|
|
191
|
+
semicolons: true
|
|
192
|
+
|
|
193
|
+
# Commit message format
|
|
194
|
+
commits: conventional # conventional | angular | custom
|