Skip to content
ring:pre-dev-research logo

ring:pre-dev-research

Gate 0 research phase for pre-dev workflow. Dispatches 3 parallel research agents to gather codebase patterns, external best practices, and framework documentation BEFORE creating PRD/TRD. Outputs research.md with file:line references.

SKILL.md

Full skill instructions

Pre-Dev Research Skill (Gate 0)

Purpose: Gather comprehensive research BEFORE writing planning documents, ensuring PRDs and TRDs are grounded in codebase reality and industry best practices.

The Research-First Principle

Traditional:  Request → PRD → Discover problems during implementation
Research-First:  Request → Research → Informed PRD → Smoother implementation

Research prevents: Reinventing existing patterns, ignoring conventions, missing framework constraints, repeating solved problems

Step 1: Determine Research Mode

BLOCKING GATE: Before dispatching agents, determine the research mode.

ModeWhen to UseExample
greenfieldNo existing patterns"Add GraphQL API" (when project has none)
modificationExtending existing functionality"Add pagination to user list API"
integrationConnecting external systems"Integrate Stripe payments"

If unclear, ask:

Before starting research: Is this (1) Greenfield - new capability, (2) Modification - extends existing, or (3) Integration - connects external systems?

Mode affects agent priority:

  • Greenfield → Web research primary (best-practices, framework-docs)
  • Modification → Codebase research primary (repo-research)
  • Integration → All agents equally weighted

Step 2: Dispatch Research Agents

Run 4 agents in PARALLEL (single message, 4 Task calls):

AgentPrompt FocusMode
ring:repo-research-analystCodebase patterns for [feature]. Search docs/​solutions/ knowledge base. Return file:line references.PRIMARY in modification
ring:best-practices-researcherExternal best practices for [feature]. Use Context7 + WebSearch. Return URLs.PRIMARY in greenfield
ring:framework-docs-researcherTech stack docs for [feature]. Detect versions from manifests. Use Context7. Return version constraints.PRIMARY in integration
ring:product-designerUser problem validation, personas, competitive UX analysis, design constraints for [feature]. Mode: ux-research.PRIMARY in greenfield, SECONDARY in others

Task invocation for product-designer:

Task(
  subagent_type="ring:product-designer",
  model="opus",
  prompt="Analyze user needs for [feature]. Mode: ux-research. Return: problem validation, preliminary personas, competitive analysis, design constraints."
)

Step 2.5: Handle Topology Configuration

If TopologyConfig is provided (from command's topology discovery):

  1. Persist in research.md frontmatter:
---
feature: {feature-name}
gate: 0
date: {YYYY-MM-DD}
research_mode: greenfield | modification | integration
agents_dispatched: 4
topology:
  scope: fullstack | backend-only | frontend-only
  structure: single-repo | monorepo | multi-repo
  modules:  # Only if monorepo or multi-repo
    backend:
      path: {path}
      language: golang | typescript
    frontend:
      path: {path}
      framework: nextjs | react | vue
  doc_organization: unified | per-module
  api_pattern: direct | bff | other  # Only if scope=fullstack
---

Document Placement (based on topology.structure):

Structureresearch.md Location
single-repodocs/​pre-dev/​{feature-name}/​research.md
monorepodocs/​pre-dev/​{feature-name}/​research.md (root)
multi-repoWrite to BOTH: {backend.path}/​docs/​pre-dev/​{feature-name}/​research.md AND {frontend.path}/​docs/​pre-dev/​{feature-name}/​research.md

Multi-repo directory creation:

# Create directories in both repos
mkdir -p "{backend.path}/​docs/​pre-dev/​{feature-name}"
mkdir -p "{frontend.path}/​docs/​pre-dev/​{feature-name}"

Multi-repo sync note: Add this footer to research.md for multi-repo:

---
**Sync Status:** This document is maintained in both repositories.
- Primary: {backend.path}/​docs/​pre-dev/​{feature-name}/​research.md
- Mirror: {frontend.path}/​docs/​pre-dev/​{feature-name}/​research.md
  1. Adjust agent dispatch for multi-module projects:

If topology.structure is monorepo or multi-repo:

  • ring:repo-research-analyst: Run ONCE per module path
    • Backend: Search {topology.modules.backend.path} for patterns
    • Frontend: Search {topology.modules.frontend.path} for patterns
  • Combine findings in single research.md with module sections:
    ### Codebase Research
    
    #### Backend Module ({path})
    [Agent output for backend]
    
    #### Frontend Module ({path})
    [Agent output for frontend]
    
  1. TopologyConfig flows to all subsequent gates:
  • Gate 1 (PRD): Reads topology from research.md frontmatter
  • Gate 2 (Feature Map): Uses topology for domain mapping
  • Gate 7 (Task Breakdown): Tags tasks with target: based on topology

Step 3: Aggregate Research Findings

Output:

  • single-repo/​monorepo: docs/​pre-dev/​{feature-name}/​research.md
  • multi-repo: Both {backend.path}/​docs/​pre-dev/​{feature-name}/​research.md AND {frontend.path}/​docs/​pre-dev/​{feature-name}/​research.md
SectionContent
Metadata (YAML frontmatter)date, feature, research_mode, agents_dispatched, topology
Executive Summary2-3 sentences synthesizing key findings
Research ModeWhy selected, what it means for focus
Codebase ResearchAgent output (file:line references)
Best Practices ResearchAgent output (URLs)
Framework DocumentationAgent output (version constraints)
Product/​UX ResearchAgent output (user problem, personas, design constraints)
SynthesisKey patterns to follow (file:line, URL, doc ref); Constraints identified; Prior solutions from docs/​solutions/; UX considerations; Open questions for PRD

Step 4: Gate 0 Validation

BLOCKING CHECKLIST:

CheckRequired For
Research mode documentedAll modes
All 4 agents returnedAll modes
research.md createdAll modes
TopologyConfig in frontmatterAll modes (if provided by command)
At least one file:line referencemodification, integration
At least one external URLgreenfield, integration
docs/​solutions/ searchedAll modes
Tech stack versions documentedAll modes
Product/​UX research documentedAll modes
User problem identifiedAll modes
Synthesis section completeAll modes
Module-specific research (if multi-module)monorepo, multi-repo

If validation fails:

  • Missing agent output → Re-run that agent
  • No codebase patterns (modification) → May need mode change
  • No external docs (greenfield) → Try different search terms
  • No UX research (product-designer) → Re-run product-designer agent

Integration with Pre-Dev Workflow

ring:pre-dev-full (10-gate): Gate 0 Research → Gate 1 PRD (reads research.md) → ... → Gate 3 TRD (reads research.md)

ring:pre-dev-feature (5-gate): Gate 0 Research → Gate 1 PRD → Gate 2 TRD → Gate 3 Tasks

Research Document Usage

In Gate 1 (PRD): Reference existing patterns with file:line; cite docs/​solutions/; include external URLs; note framework constraints

In Gate 3 (TRD): Reference implementation patterns; use version constraints; cite similar implementations

Anti-Patterns

  1. Skipping research for "simple" features - Even simple features benefit from convention checks
  2. Wrong research mode - Greenfield with heavy codebase research wastes time; modification without codebase research misses patterns
  3. Ignoring docs/​solutions/​ - Prior solutions are gold; prevents repeating mistakes
  4. Vague references without file:line - "There's a pattern somewhere" is not useful; exact locations enable quick reference