Initial commit
This commit is contained in:
Zhongwei Li
117
skills/research-documentation/SKILL.md
Normal file
117
skills/research-documentation/SKILL.md
Normal file
@@ -0,0 +1,117 @@
|
||||
---
|
||||
name: research-documentation
|
||||
description: Research topics and document findings in Notion with organized structure and sources
|
||||
---
|
||||
|
||||
## Overview
|
||||
|
||||
The Research Documentation skill automates the process of researching topics and capturing findings in a well-organized Notion database. It streamlines research by structuring information, tracking sources, and connecting related findings.
|
||||
|
||||
## When to Use
|
||||
|
||||
Use this skill when you need to:
|
||||
- Research complex topics and document findings
|
||||
- Compile competitive analysis or market research
|
||||
- Create literature reviews or research summaries
|
||||
- Build knowledge bases around specific topics
|
||||
- Track sources and citations
|
||||
- Organize research across multiple domains
|
||||
- Create research reports with sourced information
|
||||
|
||||
## Features
|
||||
|
||||
- **Structured Research Capture**: Automatically organizes research findings with proper hierarchy
|
||||
- **Source Tracking**: Maintains complete source attribution and citations
|
||||
- **Topic Organization**: Categorizes findings by theme and relevance
|
||||
- **Cross-referencing**: Connects related research across topics
|
||||
- **Evidence Collection**: Captures quotes, data, and supporting evidence
|
||||
- **Research Timeline**: Tracks how understanding evolved during research
|
||||
|
||||
## Requirements
|
||||
|
||||
- **Notion API Access**: For creating and updating research documentation
|
||||
- **Research Database**: Notion database structure for organizing findings
|
||||
- **Web Access**: For gathering information from online sources
|
||||
- **Citation Format Preference**: Configured citation style (APA, MLA, Chicago, etc.)
|
||||
|
||||
## Implementation Details
|
||||
|
||||
This skill orchestrates research workflows by:
|
||||
|
||||
1. Breaking down research topics into focused areas
|
||||
2. Gathering information from multiple sources
|
||||
3. Analyzing and synthesizing findings
|
||||
4. Organizing findings with proper attribution
|
||||
5. Creating relationships between related research
|
||||
6. Generating summary documents and reports
|
||||
|
||||
### Research Documentation Workflow
|
||||
|
||||
```
|
||||
Research Topic/Question
|
||||
↓
|
||||
Break into Research Areas
|
||||
↓
|
||||
Gather Information
|
||||
↓
|
||||
Analyze & Synthesize
|
||||
↓
|
||||
Extract Key Findings
|
||||
↓
|
||||
Organize with Sources
|
||||
↓
|
||||
Create Notion Documentation
|
||||
↓
|
||||
Output: Research Summary
|
||||
```
|
||||
|
||||
## Example Use Cases
|
||||
|
||||
1. **Competitive Analysis**
|
||||
- Research competitors and market landscape
|
||||
- Document features, pricing, and positioning
|
||||
- Create competitive comparison matrix
|
||||
|
||||
2. **Technology Evaluation**
|
||||
- Research framework/tool options
|
||||
- Document pros, cons, and use cases
|
||||
- Create evaluation report with recommendations
|
||||
|
||||
3. **Domain Knowledge Building**
|
||||
- Research industry best practices
|
||||
- Document standards and approaches
|
||||
- Create reference guide for team
|
||||
|
||||
4. **Literature Review**
|
||||
- Research academic papers on topic
|
||||
- Summarize findings and arguments
|
||||
- Create annotated bibliography
|
||||
|
||||
5. **Market Research**
|
||||
- Gather market size and trends
|
||||
- Document customer needs
|
||||
- Create market analysis report
|
||||
|
||||
## Configuration
|
||||
|
||||
```env
|
||||
NOTION_API_TOKEN=your_token_here
|
||||
RESEARCH_DATABASE_ID=your_database_id
|
||||
SOURCES_DATABASE_ID=your_sources_database_id
|
||||
CITATION_FORMAT=APA
|
||||
```
|
||||
|
||||
## Citation Formats Supported
|
||||
|
||||
- APA
|
||||
- MLA
|
||||
- Chicago Style
|
||||
- Harvard
|
||||
- IEEE
|
||||
|
||||
## See Also
|
||||
|
||||
- [Knowledge Capture](/skills/knowledge-capture) - For documenting discussions and insights
|
||||
- [Meeting Intelligence](/skills/meeting-intelligence) - For research-informed meeting prep
|
||||
- [Spec to Implementation](/skills/spec-to-implementation) - For research-based implementation planning
|
||||
- [Notion API Documentation](https://developers.notion.com)
|
||||
28
skills/research-documentation/evaluations/README.md
Normal file
28
skills/research-documentation/evaluations/README.md
Normal file
@@ -0,0 +1,28 @@
|
||||
# Research Documentation - Evaluation Scenarios
|
||||
|
||||
Test scenarios for validating research quality, sourcing, and documentation formats.
|
||||
|
||||
## Evaluation Focus
|
||||
|
||||
- **Comprehensiveness**: Are all aspects of the research topic covered?
|
||||
- **Sourcing**: Are all claims backed by sources? Are citations proper?
|
||||
- **Accuracy**: Is the information accurate and up-to-date?
|
||||
- **Format**: Does the output match the requested format?
|
||||
- **Accessibility**: Is the research understandable to the target audience?
|
||||
|
||||
## Test Scenario Types
|
||||
|
||||
1. **Quick Brief** - Fast research with key findings
|
||||
2. **Comparison Analysis** - Evaluating multiple options
|
||||
3. **Comprehensive Report** - Deep-dive research documentation
|
||||
4. **Market Research** - Industry and competitive analysis
|
||||
5. **Technical Investigation** - Product/technology research
|
||||
|
||||
## Success Criteria
|
||||
|
||||
✓ All major sources cited with proper attribution
|
||||
✓ Format requirements met (length, structure)
|
||||
✓ Key findings clearly stated
|
||||
✓ Comparisons fair and balanced
|
||||
✓ Recommendations supported by research
|
||||
✓ Ready for stakeholder presentation
|
||||
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