write-research-doc

# Write Research Document

Create structured research documents following project conventions.

## Document Structure

Use the template from `templates/research-document.md`:

1. **Frontmatter** (YAML):
   - date, researcher, git info, topic, tags, status

2. **Research Question**:
   - Original user query verbatim

3. **Summary**:
   - High-level findings (2-3 paragraphs)

4. **Detailed Findings**:
   - Organized by component/area
   - Include file:line references
   - Explain purpose and implementation

5. **Key Discoveries**:
   - Bullet list of important findings

6. **Implementation Patterns**:
   - Common patterns found

7. **References**:
   - Links to source files and related docs

## File Path and Naming

Save to: `thoughts/shared/research/YYYY-MM-DD-NN-description.md`

Format:
- `YYYY-MM-DD` - Today's date
- `NN` - Sequence number (01, 02, etc.)
- `description` - Kebab-case brief description

Example: `2025-12-23-01-authentication-flow.md`

## Metadata Collection

Use `gather-project-metadata` skill to get:
- Timestamp
- Git commit and branch
- Repository name

## File References

Always include specific file:line references:
- `src/auth/handler.go:45` - Format for references
- Use actual line numbers where functions/types are defined

## Path Corrections

Watch for these common mistakes:
- ✅ `thoughts/shared/research/` - Correct for shared research
- ❌ `thoughts/searchable/` - Old path, don't use
- ✅ `thoughts/notes/` - Correct for reference documents