1. Public Interface Contracts
For each public API define:
- Function signature / operation contract
- Input constraints and valid ranges
- Output and error semantics
- Determinism expectations
Interface rationale (fill this section):
- Explain why each public API boundary is necessary and stable.
- Explain how API design minimizes misuse and ambiguous behavior.
2. Internal Interface Contracts
Document interfaces between:
- SPDU and COP-P
- COP-P and state machine/session control
- Frame layer and physical channel
- Session controller and application layer
Capture:
- SPDU layout by type (F1, F2, 1-5)
- Directive field mappings
- Frame header fields (P/U, version, QoS)
- Endianness rules
- Validation and reject rules
Wire-format rationale (fill this section):
- Explain why each validation rule exists and what interoperability defect it prevents.
- Explain malformed-input handling policy and why graceful rejection is required.
4. Interoperability Artifacts Table
Track workshop artifact references:
- Artifact ID
- Hex dump file
- Expected decode fields
- Verification status
5. Compatibility and Versioning
- Version-3 and Version-4 handling strategy
- Backward/forward compatibility assumptions
- Unknown/unsupported field handling rules
6. Error Taxonomy
Define categories:
- Decode errors
- State transition errors
- Sequence errors
- Channel errors
- Conformance violations
Error-model rationale (fill this section):
- Explain why errors are grouped this way.
- Explain required operator/developer action for each category.
⬆️ Back to Top ⬆️