Appearance
Templates
The templates/ folder keeps small artifacts that make investigations easier to compare, review, and hand off.
| Template | Use it for | Key sections |
|---|---|---|
repo-brief.md | First-pass repository handoff. | Snapshot, purpose, run commands, key directories, core flow, risks, evidence. |
system-map.md | System boundary and interface mapping. | Scope, components, interfaces, runtime path, operational concerns, unknowns. |
repo-scorecard.md | Quick confidence and risk assessment. | Documentation, run experience, tests, deployment, observability, security, change risk. |
decision-log.md | Durable decision memory. | Date, decision, reason, impact, owner. |
open-questions.md | Investigation blockers and unresolved facts. | Question, why it matters, owner, status, needed-by date. |
Template Rules
- Keep confirmed facts separate from assumptions.
- Link evidence wherever possible.
- Close or delete stale open questions quickly.
- Record decisions that affect architecture, scope, risk posture, or rollout sequence.
Typical Bundle
For a new system investigation, start with:
repo-brief.mdsystem-map.mdrepo-scorecard.mdopen-questions.mddecision-log.md