| 1 | # SOW Specs Index |
| 2 | |
| 3 | Specs are durable project memory: current contracts, cross-cutting behavioral |
| 4 | rules, and area-specific guarantees extracted from completed work. |
| 5 | |
| 6 | Keep this directory flat until scale proves hierarchy is needed. Add one row to |
| 7 | this index in the same change that adds, renames, or removes a spec. |
| 8 | |
| 9 | ## Specs |
| 10 | |
| 11 | | Spec | Scope | Main consumers | |
| 12 | |---|---|---| |
| 13 | | [go-v2-host-scope.md](go-v2-host-scope.md) | Go framework V2 host-scope and vnode metric routing contract. | Go V2 collector work, `metrix`, `jobruntime`, `chartengine`, go.d collector docs and skills. | |
| 14 | | [query-planner-tier-selection.md](query-planner-tier-selection.md) | Automatic storage-tier selection for metric query planning. | Query planner code, API data paths, MCP metric query behavior. | |
| 15 | | [sensitive-data-discipline.md](sensitive-data-discipline.md) | Sensitive-data rules for committed artifacts, scripts, skills, specs, SOWs, commit messages, and PR text. | All repository work, SOW audits, private/public skills, token-safe scripts. | |
| 16 | | [snmp-profile-projection.md](snmp-profile-projection.md) | SNMP profile projection contract across metrics, topology, licensing, and BGP consumers. | SNMP profile authoring, ddsnmp loader/projection code, SNMP project skill. | |
| 17 | | [taxonomy.md](taxonomy.md) | Collector chart taxonomy source, validation, and generated artifact contract. | Collector taxonomy files, integrations generators/checkers, Cloud dashboard taxonomy consumption. | |
| 18 | | [topology-function-schema.md](topology-function-schema.md) | Production `netdata.topology.v1` Function payload, presentation, modal, and producer contract. | Topology producers, Function schemas, Cloud aggregation, UI rendering, topology project skill. | |
| 19 | | [topology-modes-correlation-aggregation.md](topology-modes-correlation-aggregation.md) | Topology detailed/aggregated modes, correlation, aggregation, and actor identification contract. | Topology producers, Cloud aggregator, UI modal/table behavior. | |
| 20 | | [vsphere-parity-matrix.md](vsphere-parity-matrix.md) | vSphere collector parity classification and implementation policy. | vSphere collector work, Go V2 migration decisions, reviewer parity checks. | |
| 21 | | [vsphere-v1-compatibility-manifest.md](vsphere-v1-compatibility-manifest.md) | Historical vSphere V1 compatibility baseline retained for migration traceability. | vSphere collector compatibility review and historical reference. | |
| 22 | |
| 23 | ## Adding A Spec |
| 24 | |
| 25 | - Use a flat path: `.agents/sow/specs/<domain>-<topic>.md`. |
| 26 | - Capture current reality, not aspiration. |
| 27 | - Prefer one durable contract or cross-cutting rule per file. |
| 28 | - Do not restate implementation details that are already clear from code. |
| 29 | - Do not split specs by repository path; choose the contract audience. |
| 30 | - Update this index in the same change. |
| 31 | - Run `.agents/sow/audit.sh` before commit. |
| 32 | |
| 33 | ## Reconsidering Hierarchy |
| 34 | |
| 35 | Do not add subdirectories only for aesthetics. Revisit hierarchy when the specs |
| 36 | set grows beyond roughly 25 files, or when one domain accumulates roughly 6 or |
| 37 | more specs. If hierarchy becomes necessary, use domain/contract ownership rather |
| 38 | than repository layout. |