Skill Tracer
Skills › Compound Engineering › ce-compound › resolution-template.md

resolution-template.md

96 lines · skills/ce-compound/assets/resolution-template.md at 3449230

Open on GitHub
1# Resolution Templates
2
3Choose the template matching the problem_type track (see `references/schema.yaml`).
4
5---
6

Resolution Templates

Choose the template matching the problem_type track (see references/schema.yaml).

Raw lines 1 to 6
7## Bug Track Template
8
9Use for: `build_error`, `test_failure`, `runtime_error`, `performance_issue`, `database_issue`, `security_issue`, `ui_bug`, `integration_issue`, `logic_error`
11<!-- YAML safety: array items (symptoms, applies_when, tags, related_components) starting with ` [ * & ! | > % @ ? or containing ": " must be wrapped in double quotes. See references/yaml-schema.md > "YAML Safety Rules". -->
13```markdown
14---
15title: [Clear problem title]
16date: [YYYY-MM-DD]
17category: [solutions subdirectory]
18module: [Module or area]
19problem_type: [schema enum]
20component: [corpus value, else schema suggested default]
21symptoms:
22 - [Observable symptom 1]
23root_cause: [corpus value, else schema suggested default]
24resolution_type: [schema enum]
25severity: [schema enum]
26retire_when: [optional; the outside change that would retire this doc and how to check for it, else omit this line]
27tags: [keyword-one, keyword-two]
28---
30# [Clear problem title]
32## Problem
33[1-2 sentence description of the issue and user-visible impact]
35## Symptoms
36- [Observable symptom or error]
38## What Didn't Work
39- [Attempted fix and why it failed]
41## Solution
42[The fix that worked, including code snippets when useful]
44## Why This Works
45[Root cause explanation and why the fix addresses it]
47## Prevention
48- [Concrete practice, test, or guardrail]
50## Related Issues
51- [Related docs or issues, if any]
52```
54---

Bug Track Template

Use for: build_error, test_failure, runtime_error, performance_issue, database_issue, security_issue, ui_bug, integration_issue, logic_error

<!-- YAML safety: array items (symptoms, applies_when, tags, related_components) starting with ` [ * & ! | > % @ ? or containing ": " must be wrapped in double quotes. See references/yaml-schema.md > "YAML Safety Rules". -->

---
title: [Clear problem title]
date: [YYYY-MM-DD]
category: [solutions subdirectory]
module: [Module or area]
problem_type: [schema enum]
component: [corpus value, else schema suggested default]
symptoms:
  - [Observable symptom 1]
root_cause: [corpus value, else schema suggested default]
resolution_type: [schema enum]
severity: [schema enum]
retire_when: [optional; the outside change that would retire this doc and how to check for it, else omit this line]
tags: [keyword-one, keyword-two]
---

# [Clear problem title]

## Problem
[1-2 sentence description of the issue and user-visible impact]

## Symptoms
- [Observable symptom or error]

## What Didn't Work
- [Attempted fix and why it failed]

## Solution
[The fix that worked, including code snippets when useful]

## Why This Works
[Root cause explanation and why the fix addresses it]

## Prevention
- [Concrete practice, test, or guardrail]

## Related Issues
- [Related docs or issues, if any]
Raw lines 7 to 55
56## Knowledge Track Template
58Use for: `best_practice`, `documentation_gap`, `workflow_issue`, `developer_experience`, `architecture_pattern`, `design_pattern`, `tooling_decision`, `convention`
60<!-- YAML safety: array items (symptoms, applies_when, tags, related_components) starting with ` [ * & ! | > % @ ? or containing ": " must be wrapped in double quotes. See references/yaml-schema.md > "YAML Safety Rules". -->
62```markdown
63---
64title: [Clear, descriptive title]
65date: [YYYY-MM-DD]
66category: [solutions subdirectory]
67module: [Module or area]
68problem_type: [schema enum]
69component: [corpus value, else schema suggested default]
70severity: [schema enum]
71applies_when:
72 - [Condition where this applies]
73retire_when: [optional; the outside change that would retire this doc and how to check for it, else omit this line]
74tags: [keyword-one, keyword-two]
75---
77# [Clear, descriptive title]
79## Context
80[What situation, gap, or friction prompted this guidance]
82## Guidance
83[The practice, pattern, or recommendation with code examples when useful]
85## Why This Matters
86[Rationale and impact of following or not following this guidance]
88## When to Apply
89- [Conditions or situations where this applies]
91## Examples
92[Concrete before/after or usage examples showing the practice in action]
94## Related
95- [Related docs or issues, if any]
96```

Knowledge Track Template

Use for: best_practice, documentation_gap, workflow_issue, developer_experience, architecture_pattern, design_pattern, tooling_decision, convention

<!-- YAML safety: array items (symptoms, applies_when, tags, related_components) starting with ` [ * & ! | > % @ ? or containing ": " must be wrapped in double quotes. See references/yaml-schema.md > "YAML Safety Rules". -->

---
title: [Clear, descriptive title]
date: [YYYY-MM-DD]
category: [solutions subdirectory]
module: [Module or area]
problem_type: [schema enum]
component: [corpus value, else schema suggested default]
severity: [schema enum]
applies_when:
  - [Condition where this applies]
retire_when: [optional; the outside change that would retire this doc and how to check for it, else omit this line]
tags: [keyword-one, keyword-two]
---

# [Clear, descriptive title]

## Context
[What situation, gap, or friction prompted this guidance]

## Guidance
[The practice, pattern, or recommendation with code examples when useful]

## Why This Matters
[Rationale and impact of following or not following this guidance]

## When to Apply
- [Conditions or situations where this applies]

## Examples
[Concrete before/after or usage examples showing the practice in action]

## Related
- [Related docs or issues, if any]
Raw lines 56 to 96