1.3 KiB
1.3 KiB
Documentation
Technical documentation for [Project Name]
Table of Contents
Getting Started
Research
Architecture
- Architecture — Post-implementation technical design
Templates
- Experiment Plan Template — For planning new experiments
- Milestone Template — For milestone-based planning
Documentation Guidelines
Adding New Documentation
After completing an experiment phase or milestone:
- Create a new
.mdfile in this folder - Add a link to the Table of Contents above
- Use the appropriate template:
- Experiment plan template — For planning experiments
- Milestone template — For implementation milestones
Naming Convention
| Type | Pattern | Example |
|---|---|---|
| Experiment plans | experiment-N-plan.md |
experiment-1-plan.md |
| Milestone docs | milestone-N-name.md |
milestone-1-foundation.md |
| Topic research | research-[topic].md |
research-gradient-methods.md |
| Guide docs | guide-[topic].md |
guide-data-preparation.md |