David Herrera
83c52bc011
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. |
||
|---|---|---|
| .. | ||
| README.md | ||
| TEMPLATE-build-plan.md | ||
| TEMPLATE-feature.md | ||
| architecture.md | ||
| deployment.md | ||
| development.md | ||
| getting-started.md | ||
README.md
Documentation
Technical documentation for [Project Name]
Table of Contents
Getting Started
Features
Architecture
Development
Documentation Guidelines
Adding New Documentation
After completing a feature or phase, add documentation:
- Create a new
.mdfile in this folder using the naming convention below - Add a link to the Table of Contents above
- Use the appropriate template as a starting point:
- Feature template - For documenting features
- Build plan template - 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