TeamIDE-methodology/templates/ResearchStarter/README.md

68 lines
1.5 KiB
Markdown

# [Project Name]
> One-line description of what this research investigates.
## The Problem
[What problem exists. Why current solutions are insufficient. 2-3 paragraphs max.]
## The Idea
[Your proposed approach. What makes it different. Include a diagram or table if helpful.]
## Current Status
[What works, what doesn't, what's next. Update this as the project progresses.]
| Component | Status | Key Metric |
|-----------|--------|------------|
| ... | ... | ... |
## Research Approaches
[List each approach being investigated with pros/cons.]
### Approach 1: [Name]
- **Pro:** ...
- **Con:** ...
- **Open question:** ...
## Experiment Plan
[Numbered list of planned experiments with goals.]
### Experiment 1: [Name]
**Goal:** [One sentence.]
- [Details]
- [Key question this answers]
## Success Criteria
[What results would make this research succeed vs fail.]
1. [Criterion with specific number]
2. [Criterion with specific number]
If no approach meets these criteria: [fallback plan].
## Folder Structure
```
ProjectName/
├── experiments/ # Numbered experiment runs
├── results/ # Experiment results documentation
├── data/ # Datasets (gitignored)
├── literature/ # Paper notes & prior art
├── src/ # Implementation code
├── tests/ # Test suite
└── docs/ # Technical documentation
```
## References
- [Paper/resource](URL) — one-line note
## License
[MIT Transparency License](LICENSE)