TeamIDE-methodology/templates/ResearchStarter/spec.md

649 B

Spec: [System/Component Name]

Overview

[What this system does. One paragraph.]

Constraints

  • [Hard limit 1]
  • [Hard limit 2]
  • [Hard limit 3]

Architecture

[System design. Diagrams, data flow, component interactions.]

API Surface

[Function signatures, data formats, wire protocols — whatever the system exposes.]

// Example
void system_do_thing(input_t *in, output_t *out);

Data Formats

[File formats, serialization, storage layout.]

Integration Points

[How this system connects to other projects or systems.]

Open Design Questions

  • [Question that needs resolution before implementation]
  • [Question]