mirror of
https://github.com/PR0M3TH3AN/TORCH.git
synced 2026-10-28 00:11:54 +00:00
57 lines
1.4 KiB
Markdown
57 lines
1.4 KiB
Markdown
# Agent Handoffs
|
|
|
|
This directory stores reusable context so future agents can work faster without repeating discovery.
|
|
|
|
## Directory purpose
|
|
|
|
- `learnings/`: successful patterns, proven fixes, and repeatable implementation guidance.
|
|
- `incidents/`: failures, root causes, mitigations, and prevention guidance.
|
|
|
|
## When to write a note
|
|
|
|
Create or update a note when your work reveals knowledge likely useful in future sessions.
|
|
|
|
Examples:
|
|
|
|
- A reliable fix pattern that can be reused.
|
|
- A recurring failure mode and its mitigation.
|
|
- A validation approach that prevented regressions.
|
|
|
|
If the issue is still active/reproducible, also update `KNOWN_ISSUES.md`.
|
|
|
|
## Naming convention
|
|
|
|
Use:
|
|
|
|
- `YYYY-MM-DD-short-topic.md`
|
|
|
|
Examples:
|
|
|
|
- `2026-02-14-validation-before-summary.md`
|
|
- `2026-02-14-missing-baseline-context.md`
|
|
|
|
## Required note structure
|
|
|
|
Each learning/incident note should include:
|
|
|
|
1. Context
|
|
2. Observation
|
|
3. Action taken
|
|
4. Validation performed
|
|
5. Recommendation for next agents
|
|
|
|
## Writing guidelines
|
|
|
|
- Keep entries short and actionable.
|
|
- Prefer bullets over long narrative.
|
|
- Include exact commands when useful for reproduction.
|
|
- Avoid secrets, credentials, and identifying data.
|
|
- Distinguish facts from assumptions.
|
|
|
|
## Maintenance workflow
|
|
|
|
1. Search for an existing related note.
|
|
2. Update it if it already covers your case.
|
|
3. Otherwise, add a new note using the naming convention.
|
|
4. Cross-link related notes when helpful.
|