Write Notes

Write Notes

Purpose

Capture useful institutional memory in README/Notes/ without creating note sprawl.

Use When

• The user wants a bug, investigation, audit, or debugging trail captured in repo notes.
• A change should leave behind durable troubleshooting context.
• An existing notes bundle should be updated with a new issue section.

Do Not Use When

• The user wants a plan.
• The output belongs in a guide or README instead of README/Notes/.
• The content is really inline code documentation.
• The note would be throwaway session chatter with no lasting value.

Procedure

1. Read references/index.md first.
2. Scan README/Notes/ for the best existing home before creating any new file.
3. Default to consolidation:
   • update the right high-level domain note file
   • add a new issue section inside that file
   • keep the issue self-contained with the notes-template structure
4. Create a new notes file only when the topic is durable enough to deserve its own entry point:
   • recurring subsystem problem
   • cross-cutting audit
   • report likely to be searched directly later
5. Use topic-based names for new files. Do not create a new file just because there is a new date or session.
6. Keep the note high signal:
   • summary
   • symptom
   • root cause or TBD
   • related guides
   • fix or current status
   • verification or next step
7. Keep active issues near the top. Convert fixed issues to resolved status and prune dead investigation branches after resolution.

References

Read references/index.md first.

Handoff Rules

• Hand off to markdown when the real task is markdown cleanup rather than note placement or note structure.
• Hand off to create-plan when the user wants a real implementation plan instead of notes.

Never write a plan execution log here. Phase progress belongs only in the plan's task checkboxes; the plan header states only its overall lifecycle (Planned, In-Progress, or Complete). Routine test and review output is transient; Git and CI are the evidence. Create a separate artifact only for an important external fact that cannot be reproduced from the commit. Store it under README/Notes/receipts/plan-NNN/.