TeamIDE-methodology/templates/docs/README.md

Documentation

Technical documentation for [Project Name]

Table of Contents

Getting Started

• Installation & Setup

Features

Architecture

• Tech Stack & Architecture

Development

• Development Guide
• Build & Deployment

---

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 - 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