Skip to content

Templates

The templates/ folder keeps small artifacts that make investigations easier to compare, review, and hand off.

TemplateUse it forKey sections
repo-brief.mdFirst-pass repository handoff.Snapshot, purpose, run commands, key directories, core flow, risks, evidence.
system-map.mdSystem boundary and interface mapping.Scope, components, interfaces, runtime path, operational concerns, unknowns.
repo-scorecard.mdQuick confidence and risk assessment.Documentation, run experience, tests, deployment, observability, security, change risk.
decision-log.mdDurable decision memory.Date, decision, reason, impact, owner.
open-questions.mdInvestigation 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:

  1. repo-brief.md
  2. system-map.md
  3. repo-scorecard.md
  4. open-questions.md
  5. decision-log.md

CDP operating memory.