|
| 1 | +# Session Feedback |
| 2 | + |
| 3 | +Analyze this conversation and identify what documentation or context was missing, incomplete, or incorrect. The goal is to continuously improve the project's knowledge base so future conversations are more efficient. |
| 4 | + |
| 5 | +## Step 1: Session Analysis |
| 6 | + |
| 7 | +Reflect on the work done in this conversation. For each area, identify friction points: |
| 8 | + |
| 9 | +1. **Exploration overhead**: What parts of the codebase did you have to discover by searching that should have been documented? (e.g., patterns, conventions, module responsibilities) |
| 10 | +2. **Wrong assumptions**: Did you make incorrect assumptions due to missing or misleading documentation? |
| 11 | +3. **Repeated patterns**: Did you discover recurring patterns or conventions that aren't documented anywhere? |
| 12 | +4. **Missing context**: What background knowledge would have helped you start faster? (e.g., architecture decisions, data flow, naming conventions) |
| 13 | +5. **Tooling gaps**: Were there commands, scripts, or workflows that you had to figure out? |
| 14 | + |
| 15 | +## Step 2: Documentation Audit |
| 16 | + |
| 17 | +For each friction point identified, determine the appropriate fix. Check the existing documentation to avoid duplicating what's already there: |
| 18 | + |
| 19 | +- `AGENTS.md` — Top-level project instructions and component map |
| 20 | +- `CLAUDE.md` — Entry point referencing AGENTS.md |
| 21 | +- `docs/AGENTS.md` — Documentation site guide |
| 22 | +- `infrahub_sdk/ctl/AGENTS.md` — CLI development guide |
| 23 | +- `infrahub_sdk/pytest_plugin/AGENTS.md` — Pytest plugin guide |
| 24 | +- `tests/AGENTS.md` — Testing guide |
| 25 | + |
| 26 | +Read the relevant existing files to understand what's already documented before proposing changes. |
| 27 | + |
| 28 | +## Step 3: Generate Report |
| 29 | + |
| 30 | +Present the feedback as a structured report with the following sections. Only include sections that have content — skip empty sections. |
| 31 | + |
| 32 | +### Format |
| 33 | + |
| 34 | +```markdown |
| 35 | +## Session Feedback Report |
| 36 | + |
| 37 | +### What I Was Working On |
| 38 | +<!-- Brief summary of the task(s) performed in this conversation --> |
| 39 | + |
| 40 | +### Documentation Gaps |
| 41 | +<!-- Things that should be documented but aren't --> |
| 42 | + |
| 43 | +For each gap: |
| 44 | + |
| 45 | +- **Topic**: What's missing |
| 46 | +- **Where**: Which file should contain this (existing file to update, or new file to create) |
| 47 | +- **Why**: How this would have helped during this conversation |
| 48 | +- **Suggested content**: A draft of what should be added (be specific and actionable) |
| 49 | + |
| 50 | +### Documentation Corrections |
| 51 | +<!-- Things that are documented but wrong or misleading --> |
| 52 | + |
| 53 | +For each correction: |
| 54 | + |
| 55 | +- **File**: Path to the file |
| 56 | +- **Issue**: What's wrong or misleading |
| 57 | +- **Fix**: What it should say instead |
| 58 | + |
| 59 | +### Discovered Patterns |
| 60 | +<!-- Conventions or patterns found in the code that aren't documented --> |
| 61 | + |
| 62 | +For each pattern: |
| 63 | + |
| 64 | +- **Pattern**: Description of the convention |
| 65 | +- **Evidence**: Where in the code this pattern is used (file paths) |
| 66 | +- **Where to document**: Which AGENTS.md or guide file should capture this |
| 67 | + |
| 68 | +### Memory Updates |
| 69 | +<!-- Propose additions/changes to MEMORY.md for cross-session persistence --> |
| 70 | + |
| 71 | +For each update: |
| 72 | + |
| 73 | +- **Action**: Add / Update / Remove |
| 74 | +- **Content**: What to write |
| 75 | +- **Reason**: Why this is worth remembering across sessions |
| 76 | +``` |
| 77 | + |
| 78 | +## Step 4: Apply Changes |
| 79 | + |
| 80 | +After presenting the report, ask the user which changes they want to apply. Present the options: |
| 81 | + |
| 82 | +1. **Apply all** — Create/update all proposed documentation files and memory |
| 83 | +2. **Cherry-pick** — Let the user select which changes to apply |
| 84 | +3. **None** — Just keep the report as reference, don't modify any files |
| 85 | + |
| 86 | + |
| 87 | +For approved changes: |
| 88 | + |
| 89 | +- Edit existing files when updating documentation |
| 90 | +- Create new files only when no appropriate existing file exists |
| 91 | +- Update `MEMORY.md` with approved memory changes |
| 92 | +- Keep all changes minimal and focused — don't over-document |
0 commit comments