* feat(plan-phase): --research-phase flag absorbs deleted /gsd-research-phase + scrub stale refs (#3042, #3044) #3042 (orphaned research-phase): /gsd-research-phase had a workflow file but no slash-command stub. Rather than restore the orphan, the research- only capability is now a flag on /gsd-plan-phase: /gsd-plan-phase --research-phase <N> When set, the workflow scopes to phase N, runs the research step (Section 5 of the existing plan-phase workflow), then early-exits before the planner/plan-checker/verifier chain. Per RCA against the deleted standalone, the flag adds two modifiers to fully cover the original surface (Option B from the RCA discussion): - --view : print existing RESEARCH.md to stdout, no spawn. Cheapest mode for the correction-without-replanning loop the issue reporter explicitly called out. Errors with a clear hint if RESEARCH.md is missing. - --research : reuse the existing "force re-research" semantics. In research-only mode this skips the existing-RESEARCH.md prompt and re-spawns unconditionally. - Neither flag, RESEARCH.md exists : prompt update/view/skip. Mirrors the deleted standalone's existing-artifact menu (#3042 RCA). #3044 (stale slash-command refs): scrubbed five deleted commands from all user-facing surfaces, including English docs, 4 localized doc sets (ja-JP, ko-KR, zh-CN, pt-BR), workflows, templates, and references. /gsd-check-todos → /gsd-capture --list /gsd-new-workspace → /gsd-workspace --new /gsd-status → /gsd-progress /gsd-plan-milestone-gaps → table rows / orphan sections removed (PR #3038 only scrubbed workflows/agent; missed the docs surfaces this PR covers) /gsd-research-phase → /gsd-plan-phase --research-phase Includes a fix to docs/issue-driven-orchestration.md (PR #3036) which itself referenced /gsd-new-workspace 4 times — self-correction. Removed: - get-shit-done/workflows/research-phase.md (orphan, capability absorbed into --research-phase flag) Tests: - tests/bug-3042-3044-research-flag-and-stale-refs.test.cjs — 46 structural-IR tests across both bugs: - argument-hint advertises --research-phase + --view - workflow parses --research-phase, sets RESEARCH_ONLY, early-exits before planner - --view prints RESEARCH.md without spawning - --research forces refresh in research-only mode - existing-RESEARCH.md prompt path with update/view/skip - workflows/research-phase.md is removed - 5 deleted slash-commands absent from 17 English user-facing surfaces + 16 localized doc surfaces (4 locales × 4 docs each) - replacement command tokens present where deleted ones lived 6950/6950 full suite pass. Lints clean. Closes #3042 Closes #3044 Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com> * fix: address all 8 CR findings on PR #3045 Major (3): - get-shit-done/workflows/plan-phase.md:344 — added explicit early-exit guard at Section 5.1: "Skip if RESEARCH_ONLY=true". Without it, an LLM could fall through "use existing, skip to step 6" → planner spawn, violating the research-only contract. The guard makes the early-exit unreachable from any non-research-only branch. - get-shit-done/references/continuation-format.md (3 examples) + zh-CN/.../continuation-format.md (3 examples) — pointed to `/gsd-plan-phase --research-phase` but docs/COMMANDS.md didn't document the flag. Added a full --research-phase + --view + --research modifier section to the /gsd-plan-phase flag table in COMMANDS.md so the canonical reference matches the continuation examples. Minor (5): - docs/FEATURES.md:1632 — `/gsd-plan-phase --research-phase` → `/gsd-plan-phase --research-phase <N>` (include required arg). - get-shit-done/templates/README.md:46 — NN-VALIDATION.md producer reverted from `/gsd-plan-phase --research-phase` (Nyquist) to plain `/gsd-plan-phase` (Nyquist). VALIDATION.md is created during normal Nyquist flow, not research-only mode — the bulk replacement was wrong for that line. - get-shit-done/workflows/help.md:89 — signature line was missing `--research`; added it alongside `--research-phase` and `--view`. - tests/bug-3042-3044-...:197 — promptHasView/promptHasSkip were tautological (matched anywhere in 1700-line workflow). Tightened to a proximity check anchored on "RESEARCH.md already exists" prompt header within a 600-char window. Updated workflow to emit that literal phrase. - tests/feat-2840-...:95 — workspace assertion used `/gsd-workspace` but the documented replacement is `/gsd-workspace --new`. Tightened to require both tokens (in 3 places: requiredCommands list, regex in conceptPairs, error message). 6950/6950 full suite pass. Lint clean. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 4.7 <noreply@anthropic.com>
292 lines
8.5 KiB
Markdown
292 lines
8.5 KiB
Markdown
<purpose>
|
|
Execute discovery at the appropriate depth level.
|
|
Produces DISCOVERY.md (for Level 2-3) that informs PLAN.md creation.
|
|
|
|
Called from plan-phase.md's mandatory_discovery step with a depth parameter.
|
|
|
|
NOTE: For comprehensive ecosystem research ("how do experts build this"), use /gsd-plan-phase --research-phase instead, which produces RESEARCH.md.
|
|
</purpose>
|
|
|
|
<depth_levels>
|
|
**This workflow supports three depth levels:**
|
|
|
|
| Level | Name | Time | Output | When |
|
|
| ----- | ------------ | --------- | -------------------------------------------- | ----------------------------------------- |
|
|
| 1 | Quick Verify | 2-5 min | No file, proceed with verified knowledge | Single library, confirming current syntax |
|
|
| 2 | Standard | 15-30 min | DISCOVERY.md | Choosing between options, new integration |
|
|
| 3 | Deep Dive | 1+ hour | Detailed DISCOVERY.md with validation gates | Architectural decisions, novel problems |
|
|
|
|
**Depth is determined by plan-phase.md before routing here.**
|
|
</depth_levels>
|
|
|
|
<source_hierarchy>
|
|
**MANDATORY: Context7 BEFORE WebSearch**
|
|
|
|
Claude's training data is 6-18 months stale. Always verify.
|
|
|
|
1. **Context7 MCP FIRST** - Current docs, no hallucination
|
|
2. **Official docs** - When Context7 lacks coverage
|
|
3. **WebSearch LAST** - For comparisons and trends only
|
|
|
|
See ~/.claude/get-shit-done/templates/discovery.md `<discovery_protocol>` for full protocol.
|
|
</source_hierarchy>
|
|
|
|
<process>
|
|
|
|
<step name="determine_depth">
|
|
Check the depth parameter passed from plan-phase.md:
|
|
- `depth=verify` → Level 1 (Quick Verification)
|
|
- `depth=standard` → Level 2 (Standard Discovery)
|
|
- `depth=deep` → Level 3 (Deep Dive)
|
|
|
|
Route to appropriate level workflow below.
|
|
</step>
|
|
|
|
<step name="level_1_quick_verify">
|
|
**Level 1: Quick Verification (2-5 minutes)**
|
|
|
|
For: Single known library, confirming syntax/version still correct.
|
|
|
|
**Process:**
|
|
|
|
1. Resolve library in Context7:
|
|
|
|
```
|
|
mcp__context7__resolve-library-id with libraryName: "[library]"
|
|
```
|
|
|
|
2. Fetch relevant docs:
|
|
|
|
```
|
|
mcp__context7__get-library-docs with:
|
|
- context7CompatibleLibraryID: [from step 1]
|
|
- topic: [specific concern]
|
|
```
|
|
|
|
3. Verify:
|
|
|
|
- Current version matches expectations
|
|
- API syntax unchanged
|
|
- No breaking changes in recent versions
|
|
|
|
4. **If verified:** Return to plan-phase.md with confirmation. No DISCOVERY.md needed.
|
|
|
|
5. **If concerns found:** Escalate to Level 2.
|
|
|
|
**Output:** Verbal confirmation to proceed, or escalation to Level 2.
|
|
</step>
|
|
|
|
<step name="level_2_standard">
|
|
**Level 2: Standard Discovery (15-30 minutes)**
|
|
|
|
For: Choosing between options, new external integration.
|
|
|
|
**Process:**
|
|
|
|
1. **Identify what to discover:**
|
|
|
|
- What options exist?
|
|
- What are the key comparison criteria?
|
|
- What's our specific use case?
|
|
|
|
2. **Context7 for each option:**
|
|
|
|
```
|
|
For each library/framework:
|
|
- mcp__context7__resolve-library-id
|
|
- mcp__context7__get-library-docs (mode: "code" for API, "info" for concepts)
|
|
```
|
|
|
|
3. **Official docs** for anything Context7 lacks.
|
|
|
|
4. **WebSearch** for comparisons:
|
|
|
|
- "[option A] vs [option B] {current_year}"
|
|
- "[option] known issues"
|
|
- "[option] with [our stack]"
|
|
|
|
5. **Cross-verify:** Any WebSearch finding → confirm with Context7/official docs.
|
|
|
|
6. **Create DISCOVERY.md** using ~/.claude/get-shit-done/templates/discovery.md structure:
|
|
|
|
- Summary with recommendation
|
|
- Key findings per option
|
|
- Code examples from Context7
|
|
- Confidence level (should be MEDIUM-HIGH for Level 2)
|
|
|
|
7. Return to plan-phase.md.
|
|
|
|
**Output:** `.planning/phases/XX-name/DISCOVERY.md`
|
|
</step>
|
|
|
|
<step name="level_3_deep_dive">
|
|
**Level 3: Deep Dive (1+ hour)**
|
|
|
|
For: Architectural decisions, novel problems, high-risk choices.
|
|
|
|
**Process:**
|
|
|
|
1. **Scope the discovery** using ~/.claude/get-shit-done/templates/discovery.md:
|
|
|
|
- Define clear scope
|
|
- Define include/exclude boundaries
|
|
- List specific questions to answer
|
|
|
|
2. **Exhaustive Context7 research:**
|
|
|
|
- All relevant libraries
|
|
- Related patterns and concepts
|
|
- Multiple topics per library if needed
|
|
|
|
3. **Official documentation deep read:**
|
|
|
|
- Architecture guides
|
|
- Best practices sections
|
|
- Migration/upgrade guides
|
|
- Known limitations
|
|
|
|
4. **WebSearch for ecosystem context:**
|
|
|
|
- How others solved similar problems
|
|
- Production experiences
|
|
- Gotchas and anti-patterns
|
|
- Recent changes/announcements
|
|
|
|
5. **Cross-verify ALL findings:**
|
|
|
|
- Every WebSearch claim → verify with authoritative source
|
|
- Mark what's verified vs assumed
|
|
- Flag contradictions
|
|
|
|
6. **Create comprehensive DISCOVERY.md:**
|
|
|
|
- Full structure from ~/.claude/get-shit-done/templates/discovery.md
|
|
- Quality report with source attribution
|
|
- Confidence by finding
|
|
- If LOW confidence on any critical finding → add validation checkpoints
|
|
|
|
7. **Confidence gate:** If overall confidence is LOW, present options before proceeding.
|
|
|
|
8. Return to plan-phase.md.
|
|
|
|
**Output:** `.planning/phases/XX-name/DISCOVERY.md` (comprehensive)
|
|
</step>
|
|
|
|
<step name="identify_unknowns">
|
|
**For Level 2-3:** Define what we need to learn.
|
|
|
|
Ask: What do we need to learn before we can plan this phase?
|
|
|
|
- Technology choices?
|
|
- Best practices?
|
|
- API patterns?
|
|
- Architecture approach?
|
|
</step>
|
|
|
|
<step name="create_discovery_scope">
|
|
Use ~/.claude/get-shit-done/templates/discovery.md.
|
|
|
|
Include:
|
|
|
|
- Clear discovery objective
|
|
- Scoped include/exclude lists
|
|
- Source preferences (official docs, Context7, current year)
|
|
- Output structure for DISCOVERY.md
|
|
</step>
|
|
|
|
<step name="execute_discovery">
|
|
Run the discovery:
|
|
- Use web search for current info
|
|
- Use Context7 MCP for library docs
|
|
- Prefer current year sources
|
|
- Structure findings per template
|
|
</step>
|
|
|
|
<step name="create_discovery_output">
|
|
Write `.planning/phases/XX-name/DISCOVERY.md`:
|
|
- Summary with recommendation
|
|
- Key findings with sources
|
|
- Code examples if applicable
|
|
- Metadata (confidence, dependencies, open questions, assumptions)
|
|
</step>
|
|
|
|
<step name="confidence_gate">
|
|
After creating DISCOVERY.md, check confidence level.
|
|
|
|
If confidence is LOW:
|
|
|
|
**Text mode (`workflow.text_mode: true` in config or `--text` flag):** Set `TEXT_MODE=true` if `--text` is present in `$ARGUMENTS` OR `text_mode` from init JSON is `true`. When TEXT_MODE is active, replace every `AskUserQuestion` call with a plain-text numbered list and ask the user to type their choice number. This is required for non-Claude runtimes (OpenAI Codex, Gemini CLI, etc.) where `AskUserQuestion` is not available.
|
|
Use AskUserQuestion:
|
|
|
|
- header: "Low Conf."
|
|
- question: "Discovery confidence is LOW: [reason]. How would you like to proceed?"
|
|
- options:
|
|
- "Dig deeper" - Do more research before planning
|
|
- "Proceed anyway" - Accept uncertainty, plan with caveats
|
|
- "Pause" - I need to think about this
|
|
|
|
If confidence is MEDIUM:
|
|
Inline: "Discovery complete (medium confidence). [brief reason]. Proceed to planning?"
|
|
|
|
If confidence is HIGH:
|
|
Proceed directly, just note: "Discovery complete (high confidence)."
|
|
</step>
|
|
|
|
<step name="open_questions_gate">
|
|
If DISCOVERY.md has open_questions:
|
|
|
|
Present them inline:
|
|
"Open questions from discovery:
|
|
|
|
- [Question 1]
|
|
- [Question 2]
|
|
|
|
These may affect implementation. Acknowledge and proceed? (yes / address first)"
|
|
|
|
If "address first": Gather user input on questions, update discovery.
|
|
</step>
|
|
|
|
<step name="offer_next">
|
|
```
|
|
Discovery complete: .planning/phases/XX-name/DISCOVERY.md
|
|
Recommendation: [one-liner]
|
|
Confidence: [level]
|
|
|
|
What's next?
|
|
|
|
1. Discuss phase context (/gsd-discuss-phase [current-phase])
|
|
2. Create phase plan (/gsd-plan-phase [current-phase])
|
|
3. Refine discovery (dig deeper)
|
|
4. Review discovery
|
|
|
|
```
|
|
|
|
NOTE: DISCOVERY.md is NOT committed separately. It will be committed with phase completion.
|
|
</step>
|
|
|
|
</process>
|
|
|
|
<success_criteria>
|
|
**Level 1 (Quick Verify):**
|
|
- Context7 consulted for library/topic
|
|
- Current state verified or concerns escalated
|
|
- Verbal confirmation to proceed (no files)
|
|
|
|
**Level 2 (Standard):**
|
|
- Context7 consulted for all options
|
|
- WebSearch findings cross-verified
|
|
- DISCOVERY.md created with recommendation
|
|
- Confidence level MEDIUM or higher
|
|
- Ready to inform PLAN.md creation
|
|
|
|
**Level 3 (Deep Dive):**
|
|
- Discovery scope defined
|
|
- Context7 exhaustively consulted
|
|
- All WebSearch findings verified against authoritative sources
|
|
- DISCOVERY.md created with comprehensive analysis
|
|
- Quality report with source attribution
|
|
- If LOW confidence findings → validation checkpoints defined
|
|
- Confidence gate passed
|
|
- Ready to inform PLAN.md creation
|
|
</success_criteria>
|