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:
2026-05-16 10:01:25 -05:00
commit 83c52bc011
95 changed files with 13727 additions and 0 deletions
+42
View File
@@ -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` |
@@ -0,0 +1,21 @@
# Run N: [Descriptive Name]
## Hypothesis
[What we expect to happen and why.]
## Setup
- **Architecture:** [Model/system description]
- **Key change vs previous run:** [What's different]
- **Config:** [Hyperparameters, settings]
## Expected Outcome
[What result would confirm or reject the hypothesis.]
## Run Command
```bash
[How to build and run this experiment]
```
@@ -0,0 +1,66 @@
# Milestone Plan: [Project Name]
## Dependency Graph
```
Phase 1: 1.1 --> 1.2 --> 1.3
|
Phase 2: v
2.1 --> 2.2 --> 2.3
```
---
## Phase 1: [Phase Name]
### Milestone 1.1: [Title] — PENDING
**What:** [One-sentence summary of the deliverable.]
**Tasks:**
- [ ] Task with enough detail that someone else could do it
- [ ] Another task
**Deferred:** [What was intentionally left out and why.]
**New Files:**
| File | What |
|------|------|
| path/to/file | One-line description |
**API Surface:**
[Function signatures or interface definitions, if applicable]
**Depends on:** None
**Success Criteria:** [Falsifiable statement with numbers]
**Test Cases:**
1. [Specific scenario] — [expected result]
2. [Specific scenario] — [expected result]
### Milestone 1.2: [Title] — PENDING
**What:** ...
**Depends on:** Milestone 1.1
...
---
## Phase 2: [Phase Name]
### Milestone 2.1: [Title] — PENDING
**Depends on:** Milestone 1.2
...
---
## Kill Gates
- **After Phase 1:** If [condition], abandon [approach] and [fallback action]
- **After Phase 2:** If [condition], pivot to [alternative]
@@ -0,0 +1,35 @@
# Architecture
> Technical architecture for [Project Name]
**Note:** This document is written after implementation. It describes how things actually work, not how they were planned. For the original design, see [spec.md](../spec.md).
## Tech Stack
| Layer | Technology | Purpose |
|-------|------------|---------|
| [Layer] | [Technology] | [Purpose] |
## System Design
[Diagrams, data flow, component interactions.]
## Key Design Decisions
### [Decision 1]
**Context:** [Why this decision was needed]
**Decision:** [What was decided]
**Consequences:** [Trade-offs and implications]
## Data Model
[Describe main entities, formats, and relationships]
## External Dependencies
| Dependency | Purpose | Documentation |
|------------|---------|---------------|
| [Library] | [Purpose] | [Link] |
@@ -0,0 +1,47 @@
# Getting Started
> Setup guide for [Project Name]
## Prerequisites
- [Language runtime / compiler]
- [Package manager]
- [Additional prerequisites]
## Installation
```bash
# Clone the repository
git clone https://github.com/dcherrera/[ProjectName].git
cd [ProjectName]
# Install dependencies
[install command]
```
## Running Experiments
```bash
# Run a specific experiment
[command to run experiment]
# View results
[command to view output]
```
## Project Layout
| Folder | Purpose |
|--------|---------|
| `experiments/` | Experiment code (numbered runs) |
| `results/` | Experiment results documentation |
| `data/` | Datasets (gitignored) |
| `literature/` | Paper notes & prior art |
| `src/` | Implementation code |
| `tests/` | Test suite |
## Next Steps
- Read [goals.md](../goals.md) to understand success criteria
- Check [open_questions.md](../open_questions.md) for current research questions
- Review [Architecture](./architecture.md) for technical design