TeamIDE-methodology/templates/ResearchStarter/docs/README.md

1.3 KiB

Documentation

Technical documentation for [Project Name]

Table of Contents

Getting Started

Research

Architecture

Templates


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:

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