This directory contains the canonical IOSM artifact set in two forms:
examples/: realistic sample artifactstemplates/: reusable skeletons for teams adopting IOSM
| Artifact | Example | Template |
|---|---|---|
| IOSM configuration | examples/iosm.yaml | templates/iosm.template.yaml |
| Baseline Report | examples/baseline-report.md | templates/baseline-report.template.md |
| Hypothesis Card | examples/hypothesis-card.yaml | templates/hypothesis-card.template.yaml |
| Invariant Catalog | examples/invariant-catalog.yaml | templates/invariant-catalog.template.yaml |
| Phase Report | examples/phase-report.md | templates/phase-report.template.md |
| Cycle Report | examples/cycle-report.json | templates/cycle-report.template.json |
| Metrics History | examples/metrics-history.json | templates/metrics-history.template.json |
| Waiver Register | examples/waiver-register.yaml | templates/waiver-register.template.yaml |
| Contract Catalog | examples/contract-catalog.yaml | templates/contract-catalog.template.yaml |
| Decision Log | examples/decision-log.md | templates/decision-log.template.md |
| Pattern Library | examples/pattern-library.md | templates/pattern-library.template.md |
- Start with the templates when adopting IOSM in a new system.
- Compare your outputs with the examples to understand canonical field usage.
- Use the schemas in
../schemas/for machine validation where applicable. - Keep artifact field names stable if you want cross-team comparability.