Squashed 'docs/standards/playbook/' changes from e504a68..b529012
b529012 ✅ test(tests): avoid hardcoded missing path 07583c8 🐛 fix(tests): make doc link check awk-portable 6244aa3 🔧 chore(ci): relax gitattributes check 31dd0c5 🐛 fix(scripts): require existing project root 15d4d63 🔧 chore(ci): install python3-pip 90c6313 🔧 chore(ci): run tests in a single job d84eff0 🔧 chore(ci): make actions base url configurable 395598d 🔧 chore(ci): fix yaml step names 4ae2733 ✨ feat(sync_standards): auto-detect existing languages e97fb00 ✨ feat(sync_standards): default gitattributes to append da0ef2b ✅ test: add automated tests and ci workflow 99bef30 🎨 style(markdown): format all markdown files with prettier 7e96bc8 ♻️ refactor(tsl): split function.md into 44 modular files 0d6b2a0 📝 docs(readme): add quick decision table and TL;DR for distribution methods 3b2188f 🎨 style(markdown): format markdown files with prettier 41fc43b 📝 docs(tsl): document {Unit.}Type source annotation 3dceaf7 📝 docs(tsl): clarify tsf-only top-level rules and type annotations 3a63829 📝 docs(skills): add create-plan skill f02a707 🐛 fix(scripts): escape markdown backticks in vendor_playbook 064aa92 🐛 fix(scripts): correct bat scripts 4881feb 🔧 chore(gitattributes): enforce crlf for bat files 1fa3e2a 🐛 fix(scripts): escape parentheses in sync_standards output 3958cad 📝 docs(vendor_playbook): mention ci templates 9d059cf ✨ feat(templates): add gitea ci example a52bb24 📝 docs(codex_skills): normalize markdown formatting cc8ad4c 📝 docs(skills): slim commit-message 2a98e15 🐛 fix(skills): quote YAML descriptions 8f78d22 🐛 fix(sync_standards): generate minimal AGENTS.md 5547665 ✨ feat(skills): add commit-message suggestion skill 3fe8bd7 🔧 chore(sync_standards): create AGENTS.md on sync 283d311 ✨ feat(playbook): add syntax book and codex skills tooling 5b97ed5 📝 docs(tsl): clarify syntax references 27e0700 ✨ feat(skills): add pdf/docx/pptx/xlsx wrapper workflows 5551363 ✨ feat(skills): add debugging and bulk refactor workflows 1d4f548 ✨ feat(skills): add built-in workflow skills c0895dd 📝 docs(skills): add anthropics document-skills integration cf9f80d 🔧 chore(playbook): add Claude Code skills guide and align python templates git-subtree-dir: docs/standards/playbook git-subtree-split: b529012c59c5d67c3073884d7b617763647417fd
This commit is contained in:
@@ -0,0 +1,59 @@
|
||||
---
|
||||
name: root-cause-tracing
|
||||
description:
|
||||
"Root cause analysis (RCA) and tracing failures back to the original trigger
|
||||
across layers. Triggers: root cause, RCA, tracing, 回溯, 根因, 追溯,
|
||||
为什么会发生."
|
||||
---
|
||||
|
||||
# Root Cause Tracing(根因溯源 / RCA)
|
||||
|
||||
## When to Use
|
||||
|
||||
- Incidents, regressions, flaky tests, recurring bugs
|
||||
- “Fix the symptom” patches where the underlying trigger is unknown
|
||||
- Multi-layer failures (client → service → DB → async jobs)
|
||||
|
||||
## Inputs(required)
|
||||
|
||||
- Evidence: logs, stack traces, metrics, failing test output
|
||||
- Timeline: when it started, what changed, rollout events
|
||||
- Scope: affected users/paths, frequency, severity
|
||||
- Verification: how to reproduce (or how to detect reliably)
|
||||
|
||||
## Procedure(default)
|
||||
|
||||
1. **Frame the Failure**
|
||||
- Define expected vs actual behavior
|
||||
- Identify the earliest known bad signal
|
||||
|
||||
2. **Trace Backwards**
|
||||
- Walk back through layers: surface error → caller → upstream trigger
|
||||
- Look for the first point where invariants were violated
|
||||
|
||||
3. **Find the Trigger**
|
||||
- What input/state/sequence causes it?
|
||||
- What changed around that area (code/config/deps/data)?
|
||||
|
||||
4. **Fix at the Right Layer**
|
||||
- Prefer root-cause fix + defense-in-depth guardrails
|
||||
- Add regression test or a deterministic repro harness
|
||||
|
||||
5. **Validate**
|
||||
- Reproduce before fix; verify after fix
|
||||
- Add monitoring/alerts if appropriate
|
||||
|
||||
## Output Contract(stable)
|
||||
|
||||
- Summary: what broke and impact
|
||||
- Root cause: the earliest causal violation + why it happened
|
||||
- Trigger: minimal repro steps / conditions
|
||||
- Fix: what changed and why it prevents recurrence
|
||||
- Verification: tests/commands + evidence
|
||||
- Follow-ups: guardrails/observability/rollout notes
|
||||
|
||||
## Guardrails
|
||||
|
||||
- Don’t stop at “where it crashed”; find “why the bad state existed”
|
||||
- Separate contributing factors vs root cause
|
||||
- Avoid speculative RCA; label assumptions and request missing evidence
|
||||
Reference in New Issue
Block a user