From e655922db23c380ff8e62e4ffc8d09e82fe3d691 Mon Sep 17 00:00:00 2001 From: Craig Jennings Date: Sat, 17 Jan 2026 13:01:02 -0600 Subject: Add docs directory Project documentation and workflow definitions. --- docs/NOTES.org | 247 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 247 insertions(+) create mode 100644 docs/NOTES.org (limited to 'docs/NOTES.org') diff --git a/docs/NOTES.org b/docs/NOTES.org new file mode 100644 index 0000000..f56e7bd --- /dev/null +++ b/docs/NOTES.org @@ -0,0 +1,247 @@ +#+TITLE: Claude Code Notes - [Project Name] +#+AUTHOR: Craig Jennings & Claude +#+DATE: [Date] + +* About This File + +This file contains project-specific information for this project. + +**When to read this:** +- At the start of EVERY session (after reading protocols.org) +- When needing project context or history +- When checking reminders or pending decisions + +**What's in this file:** +- Project-specific context and goals +- Available workflows for this project +- Active reminders +- Pending decisions +- Session history + +**For protocols and conventions, see:** [[file:protocols.org][protocols.org]] + +* Project-Specific Context + +This is where context regarding this project is placed. + +Examples of what goes here: +- Project overview and goals +- People and their relationships to the user +- Contact information for companies and people +- Current state of the project +- Status report +- Links to important documents +- Technical architecture notes +- Key decisions and rationale + +** Welcome to Your First Session! + +This is your first session with Craig on this project. + +**First session checklist:** +1. **Determine project type and git/docs policy:** + - Is this project in a git repository? + - **Is this a code project** (Emacs package, library, software project)? + - **YES (code project):** Add docs/ to .gitignore (private notes, not part of codebase) + - Examples: org-msg, chime.el, wttrin, or any future Emacs packages/libraries + - docs/ contains session notes and should remain private + - **NO (non-code project):** Commit docs/ normally (part of the project documentation) + - Examples: personal projects, business planning, documentation projects + - docs/ is project documentation and should be versioned + - What are the remote repositories (if any)? + +2. **Understand the project:** + - Ask what the project is about + - Ask what the goals of the project are + - Ask any clarifying questions along the way + +3. **Brainstorm how to help:** + - Discuss approaches and strategies + - Identify immediate next steps + +4. **Document learnings:** + - Record what you learned in relevant sections of this document + - Add project-specific context below this section + +5. **Clean up:** + - Remove this "Welcome to Your First Session!" heading and its content + - Update Project-Specific Context section with actual project information + +* AVAILABLE WORKFLOWS + +This section lists all documented workflows for this project. Update this section whenever a new workflow is created. + +** create-workflow +File: [[file:workflows/create-workflow.org][docs/workflows/create-workflow.org]] + +Meta-workflow for creating new workflows. Use this when identifying repetitive workflows that would benefit from documentation. + +Workflow: +1. Q&A discovery (4 core questions) +2. Assess completeness +3. Name the workflow +4. Document it +5. Update NOTES.org +6. Validate by execution + +Created: [Date when workflow was created] + +** create-v2mom +File: [[file:workflows/create-v2mom.org][docs/workflows/create-v2mom.org]] + +Workflow for creating a V2MOM (Vision, Values, Methods, Obstacles, Metrics) strategic framework for any project or goal. + +Workflow: +1. Understand V2MOM framework +2. Create document structure +3. Define Vision (aspirational picture of success) +4. Define Values (2-4 principles with concrete definitions) +5. Define Methods (4-7 approaches ordered by priority) +6. Identify Obstacles (honest personal/technical challenges) +7. Define Metrics (measurable outcomes) +8. Review and refine +9. Commit and use immediately + +Time: ~2-3 hours total +Applicable to: Any project (health, finance, software, personal infrastructure, etc.) + +Created: 2025-11-05 + +** session-start +File: [[file:workflows/session-start.org][docs/workflows/session-start.org]] + +Workflow for beginning a Claude Code session with proper context and priorities. + +Triggered by: **Automatically at the start of EVERY session** + +Workflow: +1. Add session start timestamp (check for interrupted sessions) +2. Sync with templates (exclude NOTES.org and previous-session-history.org) +3. Scan workflows directory for available workflows +4. Read key NOTES.org sections (NOT entire file) +5. Process inbox (mandatory) +6. Ask about priorities (urgent work vs what's-next workflow) + +Ensures: Full context, current templates, processed inbox, clear session direction + +Created: 2025-11-14 + +** session-wrap-up +File: [[file:workflows/session-wrap-up.org][docs/workflows/session-wrap-up.org]] + +Workflow for ending a Claude Code session cleanly with proper documentation and version control. + +Triggered by: "wrap it up," "that's a wrap," "let's call it a wrap," or similar phrases + +Workflow: +1. Write session notes to NOTES.org Session History section +2. Archive sessions older than 5 sessions to previous-session-history.org +3. Git commit and push all changes (NO Claude attribution) +4. Provide brief valediction with accomplishments and next steps + +Ensures: Clean handoff between sessions, nothing lost, clear git history, proper documentation + +Created: 2025-11-14 + +** [Add more workflows as they are created] + +Format for new entries: +#+begin_example +** workflow-name +File: [[file:workflows/workflow-name.org][docs/workflows/workflow-name.org]] + +Brief description of what this workflow does. + +Workflow: +1. Step 1 +2. Step 2 +3. Step 3 + +Created: YYYY-MM-DD +#+end_example + +* PENDING DECISIONS + +This section tracks decisions that need Craig's input before work can proceed. + +**Instructions:** +- Add pending decisions as they arise during sessions +- Format: =** [Topic/Feature Name]= +- Include: What needs to be decided, options available, why it matters +- Remove decisions once resolved (document resolution in Session History) + +**Example format:** +#+begin_example +** Feature Name or Topic + +Craig needs to decide on [specific question]. + +Options: +1. Option A - [brief description, pros/cons] +2. Option B - [brief description, pros/cons] + +Why this matters: [impact on project] + +Implementation is ready - just need Craig's preference. +#+end_example + +** Current Pending Decisions + +(None currently - will be added as they arise) + +* Active Reminders + +** Current Reminders + +(None currently - will be added as needed) + +** Instructions for This Section + +When Craig says "remind me" about something: +1. Add it here with timestamp and description +2. If it's a TODO, also add to =/home/cjennings/sync/org/roam/inbox.org= scheduled for today +3. Check this section at start of every session +4. Remove reminders once addressed + +Format: +- =[YYYY-MM-DD]= Description of what to remind Craig about + +* Session History + +This section contains notes from each session with Craig. Sessions are logged in reverse chronological order (most recent first). + +**Note:** Sessions older than 5 sessions are archived in [[file:previous-session-history.org][Previous Session History]] + +** Format for Session History Entries + +Each entry should use this format: + +- **Timestamp:** =*** YYYY-MM-DD Day @ HH:MM TZ= (get TZ with =date +%z=) +- **Time estimate:** How long the session took +- **Status:** COMPLETE / IN PROGRESS / PAUSED +- **What We Completed:** Bulleted list of accomplishments +- **Key Decisions:** Any important decisions made +- **Files Modified:** Links to changed files (use relative paths) +- **Next Steps:** What to do next session (if applicable) + +**Best practices:** +- Keep entries concise but informative +- Include enough context to resume work later +- Document important technical insights +- Note any new patterns or preferences discovered +- Link to files using org-mode =file:= links + +** Session Entries + +*** [First session date] + +*Time:* Initial setup +*Status:* COMPLETE - Template created + +*What We Completed:* +- Project initialized with Claude Code templates +- Ready for first work session + +*Next Steps:* +- Begin first actual work session +- Follow "Welcome to Your First Session!" checklist above -- cgit v1.2.3