Initial extract: templates + methodology guide from Ideation
Public, version-controlled source of truth for TeamIDE's project templates, coding conventions, and the build-plan → PM scaffolding rules. Mounted read-only by TeamIDE's planner agent at runtime. Extracted from the personal Ideation repo as a precondition for workspace-projects-agent-spec.md §9.4. Personal Ideation stays private; this repo holds only the publishable methodology.
This commit is contained in:
@@ -0,0 +1,42 @@
|
||||
# Documentation
|
||||
|
||||
> Technical documentation for [Project Name]
|
||||
|
||||
## Table of Contents
|
||||
|
||||
### Getting Started
|
||||
- [Setup Guide](./getting-started.md)
|
||||
|
||||
### Research
|
||||
<!-- Add experiment plans and milestone docs as the project progresses -->
|
||||
<!-- Example: [Experiment 1 Plan](./experiment-1-plan.md) -->
|
||||
|
||||
### Architecture
|
||||
- [Architecture](./architecture.md) — Post-implementation technical design
|
||||
|
||||
### Templates
|
||||
- [Experiment Plan Template](./TEMPLATE-experiment-plan.md) — For planning new experiments
|
||||
- [Milestone Template](./TEMPLATE-milestone.md) — For milestone-based planning
|
||||
|
||||
---
|
||||
|
||||
## Documentation Guidelines
|
||||
|
||||
### Adding New Documentation
|
||||
|
||||
After completing an experiment phase or milestone:
|
||||
|
||||
1. Create a new `.md` file in this folder
|
||||
2. Add a link to the Table of Contents above
|
||||
3. Use the appropriate template:
|
||||
- [Experiment plan template](./TEMPLATE-experiment-plan.md) — For planning experiments
|
||||
- [Milestone template](./TEMPLATE-milestone.md) — 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` |
|
||||
Reference in New Issue
Block a user