Initial commit
This commit is contained in:
168
skills/research-documentation/reference/format-guide.md
Normal file
168
skills/research-documentation/reference/format-guide.md
Normal file
@@ -0,0 +1,168 @@
|
||||
# Research Documentation - Format Selection Guide
|
||||
|
||||
Choose the right format for your research output based on scope, complexity, and intended audience.
|
||||
|
||||
## Quick Brief
|
||||
|
||||
**Best for:** Initial findings, quick summaries, stakeholder updates
|
||||
|
||||
**Length:** 1-2 pages
|
||||
**Structure:**
|
||||
- Question/Topic
|
||||
- Key Findings (3-5 bullet points)
|
||||
- Sources Used
|
||||
- Next Steps
|
||||
|
||||
**Example Use:**
|
||||
"Should we adopt React or Vue?"
|
||||
→ Quick Brief comparing both with recommendation
|
||||
|
||||
---
|
||||
|
||||
## Comparison Matrix
|
||||
|
||||
**Best for:** Evaluating multiple options against criteria
|
||||
|
||||
**Structure:**
|
||||
```
|
||||
| Criteria | Option A | Option B | Option C |
|
||||
|----------|----------|----------|----------|
|
||||
| Cost | $ | $$ | $$$ |
|
||||
| Learning Curve | Easy | Medium | Hard |
|
||||
| ... | | | |
|
||||
```
|
||||
|
||||
**Example Use:**
|
||||
Technology evaluation, vendor comparison, feature analysis
|
||||
|
||||
---
|
||||
|
||||
## Research Summary
|
||||
|
||||
**Best for:** Balanced overview of a topic with findings and recommendations
|
||||
|
||||
**Length:** 2-4 pages
|
||||
**Structure:**
|
||||
- Overview
|
||||
- Key Findings
|
||||
- Analysis & Synthesis
|
||||
- Recommendations
|
||||
- Sources & Citations
|
||||
|
||||
**Example Use:**
|
||||
Market trends, industry analysis, competitive landscape
|
||||
|
||||
---
|
||||
|
||||
## Comprehensive Report
|
||||
|
||||
**Best for:** Deep dives, detailed analysis, archival
|
||||
|
||||
**Length:** 5-20 pages
|
||||
**Structure:**
|
||||
- Executive Summary
|
||||
- Introduction & Context
|
||||
- Methodology
|
||||
- Findings (organized by theme)
|
||||
- Analysis & Implications
|
||||
- Recommendations
|
||||
- Appendices
|
||||
- References
|
||||
|
||||
**Example Use:**
|
||||
Product research, technical investigation, business analysis
|
||||
|
||||
---
|
||||
|
||||
## Decision Memo
|
||||
|
||||
**Best for:** Research that informs a specific decision
|
||||
|
||||
**Structure:**
|
||||
- Decision Required
|
||||
- Background
|
||||
- Research Findings
|
||||
- Options with Trade-offs
|
||||
- Recommendation
|
||||
- Implementation Steps
|
||||
|
||||
**Example Use:**
|
||||
Technology selection, resource allocation, strategic direction
|
||||
|
||||
---
|
||||
|
||||
## Selection Flowchart
|
||||
|
||||
```
|
||||
What are you researching?
|
||||
|
||||
├─ Quick answer needed?
|
||||
│ └─ Quick Brief
|
||||
│
|
||||
├─ Comparing options?
|
||||
│ └─ Comparison Matrix
|
||||
│
|
||||
├─ Balanced overview?
|
||||
│ └─ Research Summary
|
||||
│
|
||||
├─ Supporting a decision?
|
||||
│ └─ Decision Memo
|
||||
│
|
||||
└─ Comprehensive documentation?
|
||||
└─ Comprehensive Report
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Format Standards
|
||||
|
||||
**Citation Style**
|
||||
- APA, MLA, Chicago, or Harvard
|
||||
- Include author, date, source
|
||||
- Use consistent format throughout
|
||||
|
||||
**Sourcing**
|
||||
- Link to actual sources
|
||||
- Note access date for web content
|
||||
- Mark primary vs. secondary sources
|
||||
- Include direct quotes with attribution
|
||||
|
||||
**Structure**
|
||||
- Clear headings (H2, H3, etc.)
|
||||
- Short paragraphs (2-4 sentences)
|
||||
- Bullet points for lists
|
||||
- Tables for comparisons
|
||||
|
||||
**Visual Elements**
|
||||
- Include relevant charts/graphs
|
||||
- Use consistent formatting
|
||||
- Add images/screenshots with captions
|
||||
- Label tables and figures clearly
|
||||
|
||||
---
|
||||
|
||||
## Examples by Format
|
||||
|
||||
### Example 1: Quick Brief
|
||||
**Topic:** Headless CMS Options
|
||||
**Sources:** 2 tools evaluated
|
||||
**Decision Time:** 2 hours research
|
||||
**Outcome:** Recommendation selected in 1 day
|
||||
|
||||
### Example 2: Comparison Matrix
|
||||
**Topic:** Email Service Providers
|
||||
**Sources:** 4 vendors evaluated
|
||||
**Decision Time:** 4 hours research
|
||||
**Outcome:** Feature matrix drives selection
|
||||
|
||||
### Example 3: Research Summary
|
||||
**Topic:** AI Model Options for Product
|
||||
**Sources:** 10+ sources reviewed
|
||||
**Decision Time:** 8 hours research
|
||||
**Outcome:** Technical team briefed, approach chosen
|
||||
|
||||
### Example 4: Comprehensive Report
|
||||
**Topic:** Market Analysis for New Product
|
||||
**Sources:** 20+ sources, interviews
|
||||
**Decision Time:** 40+ hours research
|
||||
**Outcome:** Business case developed, investment approved
|
||||
Reference in New Issue
Block a user