Skip to content

[Component Name] — Component Specification

A "component" here is a reusable technical building block (module, service, workbook module, UI component, etc.) intended for reuse across features or products — not a full product itself.

Summary

[What this component does, and why it exists as a distinct, reusable unit.]

Interface

[The contract this component exposes — inputs, outputs, parameters, events, API surface. Be precise; this is what consumers rely on.]

Internal behavior (as needed)

[Enough detail for a reader to understand how it works, without necessarily duplicating the implementation.]

Compatibility target

[What environments/versions/platforms this component is expected to work with. Do not assert compatibility that has not been tested — mark untested targets explicitly as untested.]

Dependencies

[What this component depends on.]

Status

[proposed | specified | in-development | tested | reusable | deprecated — see schemas/component.schema.json for the canonical enum.]

Known limitations

  • [Limitation 1]
  • [Links to features/products that use this component.]

Report an issue about this page