Skip to content

Interface Contract

This is a template. Replace every bracketed placeholder. This file itself establishes no policy.

This document defines the implementation-agnostic contract this component exposes to a product that adopts it — what it expects to receive and what it guarantees to provide — independent of how it happens to be built in Excel. A product should be able to satisfy this contract without reading implementation-notes.md.

Expected Inputs (What a Consuming Product Must Provide)

Named Range / Input Expected Format Required Notes
[name] [e.g. numeric, single cell, currency] [Y/N] [notes]
[name] [format] [Y/N] [notes]

Provided Outputs (What This Component Guarantees)

Named Range / Output Format Guaranteed Behavior Notes
[name] [format] [e.g. "always returns a value or explicit error text, never blank"] [notes]
[name] [format] [behavior] [notes]

Naming Convention

  • [State the naming convention this component's named ranges follow, consistent with the consuming product's workbook-specification.md convention]

Failure Modes

  • [What happens if a required input is missing/malformed — does the component fail loudly, silently degrade, or return a defined error state?]

Versioning

  • Contract version: [semantic version of this contract, independent of the component's own implementation version]
  • Breaking change policy: [what counts as a breaking change to this contract, and how consuming products would need to react]

This is a template. Replace bracketed placeholders. This file itself establishes no policy.


Report an issue about this page