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,50 @@
|
||||
# Documentation
|
||||
|
||||
> Technical documentation for [Project Name]
|
||||
|
||||
## Table of Contents
|
||||
|
||||
### Getting Started
|
||||
- [Installation & Setup](./getting-started.md)
|
||||
|
||||
### Features
|
||||
<!-- Add feature docs as they're built. Format: [Feature Name](./feature-name.md) -->
|
||||
|
||||
### Architecture
|
||||
- [Tech Stack & Architecture](./architecture.md)
|
||||
|
||||
### Development
|
||||
- [Development Guide](./development.md)
|
||||
- [Build & Deployment](./deployment.md)
|
||||
|
||||
---
|
||||
|
||||
## Documentation Guidelines
|
||||
|
||||
### Adding New Documentation
|
||||
|
||||
After completing a feature or phase, add documentation:
|
||||
|
||||
1. Create a new `.md` file in this folder using the naming convention below
|
||||
2. Add a link to the Table of Contents above
|
||||
3. Use the appropriate template as a starting point:
|
||||
- [Feature template](./TEMPLATE-feature.md) - For documenting features
|
||||
- [Build plan template](./TEMPLATE-build-plan.md) - For creating structured build plans
|
||||
|
||||
### Naming Convention
|
||||
|
||||
| Type | Pattern | Example |
|
||||
|------|---------|---------|
|
||||
| Feature docs | `feature-[name].md` | `feature-authentication.md` |
|
||||
| Component docs | `component-[name].md` | `component-sidebar.md` |
|
||||
| Integration docs | `integration-[name].md` | `integration-nhost.md` |
|
||||
| Guide docs | `guide-[topic].md` | `guide-testing.md` |
|
||||
| Build plans | `[name]-build-plan.md` | `auth-build-plan.md` |
|
||||
|
||||
### Documentation Structure
|
||||
|
||||
Each feature doc should include:
|
||||
- **Overview** - What the feature does
|
||||
- **Usage** - How to use it (with code examples)
|
||||
- **Configuration** - Available options/settings
|
||||
- **Related** - Links to related features/components
|
||||
Reference in New Issue
Block a user