63 lines
1.7 KiB
Markdown
63 lines
1.7 KiB
Markdown
<!--
|
|
|
|
# Scratchpad
|
|
|
|
Temporary information holder for the next iteration. Developers may create or
|
|
delete this file at any time. Anything durable should move into code, tests, or
|
|
canonical docs, then this file should disappear.
|
|
|
|
|
|
## Goal
|
|
|
|
Use this section for the current slice of work. It should explain what the
|
|
scratchpad is helping us move forward right now.
|
|
|
|
## Settled
|
|
|
|
Use this for decisions that are stable enough to guide the next steps, but are
|
|
still temporary enough to live in the scratchpad for now.
|
|
|
|
## Focused Snapshot
|
|
|
|
Use an extra section like this only when one slice needs its own compact
|
|
summary. This is useful when a specific API, boundary, or model was recently
|
|
recreated and should be captured clearly.
|
|
|
|
|
|
## Open
|
|
|
|
Use this for unresolved questions, design choices, and risks that still need a
|
|
decision.
|
|
|
|
## Sketches
|
|
|
|
Use this for rough candidate structures, names, or shapes. Keep it explicit
|
|
that these are sketches, not committed architecture.
|
|
|
|
|
|
## Gaps Right Now
|
|
|
|
Use this for concrete missing pieces in the current repo state. This section
|
|
should describe what is absent or incomplete, not broad future ambitions.
|
|
|
|
## Next
|
|
|
|
Use this for the immediate sequence of work. It should be short, ordered, and
|
|
biased toward the next deliverable rather than a long roadmap.
|
|
|
|
## Delete When
|
|
|
|
Use this to define when the scratchpad should disappear. That keeps it clearly
|
|
temporary and helps prevent it from turning into shadow documentation.
|
|
|
|
|
|
## Suggested Style
|
|
|
|
- Prefer short bullets over long prose.
|
|
- Keep facts, questions, and rough sketches in separate sections.
|
|
- Add custom sections only when they help the next iteration move faster.
|
|
- Move durable outcomes out of the scratchpad once they stop being temporary.
|
|
|
|
|
|
-->
|