trace
TRACE (Type/Readability/Atomic/Cognitive/Essential) lens for explaining code and proposing improvements (no edits applied).
Installation
Follow the repository instructions for this skill and your agent. Review the files and dependencies before adding it to your workflow.
View source ↗GuidesSkill instructions
Trace
Intent
Explain code by tracing what it does and scoring friction through TRACE.
Deliver actionable suggestions (file/line targets + minimal patch sketches) but do not modify files.
When to use
- “trace it” / “what is this doing?”
- Explain confusing control flow or hidden side effects.
- Readability/cognitive-load feedback when you want analysis-only.
- Refactor planning (“what would you change?”) without implementation.
Workflow
- Choose the slice: entrypoint, inputs, outputs, and state.
- Build a cognitive heat map (hotspots + surprises).
- Trace behavior: happy path + key failure paths; call out mutations/IO.
- Apply the TRACE checklist (below) to each hotspot.
- Propose suggested edits:
- 1–3 smallest improvements per hotspot.
- Include file:line targets.
- Use short pseudo-diffs or code sketches.
- Stop before editing; if changes are desired, escalate to
$fix.
Guardrails
- No file edits, no commits.
- No running commands unless explicitly requested.
- If expected behavior is unclear/product-sensitive, stop and ask.
- If you suspect crash/corruption risk, recommend
$fix.
TRACE checklist
- Type: make invalid states unrepresentable; eliminate “maybe” states where possible.
- Readability: understandable in 30 seconds; names match behavior.
- Atomic: one responsibility per unit; explicit side effects.
- Cognitive: minimize branching, hidden dependencies, and cross-file hops.
- Essential: keep only domain-required complexity; delete incidental ceremony.
Activation cues
- "trace" / "walk me through" / "explain"
- "what is this doing" / "why is this complex"
- "readability" / "cognitive load" (analysis-only)
- "suggest improvements" / "refactor plan"
Examples
Read the usage examples in the source repository.
View source ↗Source history
- Indexed on
- 2026-01-20
- Index updated
- 2026-01-26
- Branch
- main
Index and sync dates describe this directory. View the source repository for code history.
GitHub ↗chat Comments (0)
Sign in to join the discussion and leave a comment.
No comments yet. Be the first to share your thoughts!