Skip to content

Commit f1119ae

Browse files
docs: resolve CodeRabbit nitpick comments
- Add cross-reference from comparison doc to PROGRESS.md roadmap - Clarify good vs bad examples in code-analyst.md - Add forward reference to context_bootstrap.md from code-analyst.md - Make decision sources explicit with line numbers in PROGRESS.md - Add note about question scope in generate-context.md - Add migration impact note to research-synthesis.md - Reduce word repetition in decision rationale questions - Fix compound modifier hyphenation (Medium-and-Low-Confidence) Co-authored-by: Gregg Coppen <[email protected]>
1 parent 1f8152d commit f1119ae

File tree

5 files changed

+28
-6
lines changed

5 files changed

+28
-6
lines changed

docs/research/codebase-context/claude-code-feature-dev-comparison.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -772,6 +772,9 @@ Create `docs/workflow.md`:
772772

773773
## Implementation Priority
774774

775+
See [docs/roadmap/PROGRESS.md](../../roadmap/PROGRESS.md) for detailed Phase 2 planning,
776+
effort estimates, and acceptance criteria.
777+
775778
### Sprint 1: Critical Gaps (Week 1)
776779

777780
- [ ] Enhance `generate-spec` with mandatory clarifying phase

docs/research/codebase-context/code-analyst.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,9 @@ description: Specialized agent for analyzing source code to discover what the sy
66

77
# Code Analyst
88

9+
You are a specialized code analysis agent, part of the context_bootstrap pattern
10+
(see [context_bootstrap.md](./context_bootstrap.md) for orchestration details).
11+
912
You are a Code Analyst with expertise in reverse-engineering systems through source code analysis. Your job is to discover what a system does and how it's built by analyzing its implementation.
1013

1114
## Your Job
@@ -177,6 +180,8 @@ Return a structured summary that the manager can use:
177180
### Output Examples: Good vs Bad
178181

179182
**Good Analysis** (focuses on what exists and works):
183+
184+
This demonstrates: specific evidence, confidence marking, working features only
180185
```markdown
181186
### System Capabilities
182187
- REST API exposes catalog search, item detail, and purchase flows (Entry point: `services/api/catalog/routes.ts#L12`)
@@ -202,6 +207,8 @@ Return a structured summary that the manager can use:
202207

203208
**Bad Analysis** (too detailed, judges code, lists missing features):
204209

210+
Problems: includes code quality judgments, specific versions, missing features, internal models
211+
205212
```markdown
206213
### System Capabilities
207214
- REST API with 5 endpoints (GOOD CODE QUALITY, well-tested)

docs/research/codebase-context/research-synthesis.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -276,6 +276,14 @@ Following Information Analyst patterns:
276276
- Save to `/tasks/[n]-context-[name].md`
277277
```
278278

279+
### Migration Impact
280+
281+
This restructuring will change the output format and process. Users with existing
282+
codebase context documents should:
283+
- **Still valid:** All file:line citations remain accurate
284+
- **May need updating:** If they reference specific sections, page numbers may shift
285+
- **Recommended:** Regenerate context analyses using the new prompt format for consistency
286+
279287
---
280288

281289
### 🔴 HIGH PRIORITY: Add Evidence Citation Standards

docs/roadmap/PROGRESS.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -620,7 +620,8 @@ The following improvements are **documented and ready to implement** but will be
620620

621621
**Decision:** Require file:line for code, path#heading for docs, dated quotes for users
622622
**Rationale:** Provides traceability and accountability for all findings
623-
**Source:** code-analyst.md + information-analyst.md patterns
623+
**Source:** code-analyst.md (lines 267-273, Key Principles),
624+
information-analyst.md (lines 151-159, Key Principles)
624625

625626
### Decision 2: Confidence Levels
626627

@@ -638,7 +639,8 @@ The following improvements are **documented and ready to implement** but will be
638639

639640
**Decision:** Replace batch questionnaires with short focused rounds
640641
**Rationale:** Better user engagement, more thoughtful answers
641-
**Source:** context_bootstrap.md + Claude Code Phase 3 pattern
642+
**Source:** context_bootstrap.md (lines 38-42, Interactive Dialog principle),
643+
Claude Code Phase 3 (see docs/research/codebase-context/claude-code-feature-dev-comparison.md, lines 66-87)
642644

643645
### Decision 5: Mandatory Clarifying Phase
644646

prompts/generate-context.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -198,7 +198,7 @@ Categorize every finding by confidence level:
198198
- If no code references found → Start with Low Confidence
199199
- If docs are >6 months old without code confirmation → Maximum Medium Confidence
200200

201-
### Always Flag Medium and Low Confidence Items for User Validation
201+
### Always Flag Medium- and Low-Confidence Items for User Validation
202202

203203
## Process
204204

@@ -261,6 +261,9 @@ Automatically detect and analyze:
261261

262262
#### Questions for User (Short - 3 questions max)
263263

264+
**Important:** Keep questions brief and focused. Extended questionnaires reduce engagement
265+
and response quality. You'll ask follow-up questions in Phase 5 based on these answers.
266+
264267
1. **Scope:** Should I analyze the entire codebase, or focus on specific components? If specific, which ones?
265268

266269
2. **Purpose:** What's the primary reason for this analysis?
@@ -319,9 +322,8 @@ Find and catalog:
319322

320323
- Why was [technology X] chosen?
321324
- Why [pattern Y] over alternatives?
322-
- What constraints drove decisions?
323-
- What trade-offs were considered?
324-
- What problems were these choices solving?
325+
- What constraints or trade-offs influenced these decisions?
326+
- What problems did these choices solve?
325327

326328
**For each rationale found:**
327329

0 commit comments

Comments
 (0)