Skip to content

Document sppf_audit subsystem (SPPF status consistency audit orchestrator) #416

Description

@mikemol

Justification

src/gabion_governance/sppf_audit/ is the audit coordination layer for the SPPF governance pipeline and has zero markdown documentation. It orchestrates SPPF status consistency checks via dependency injection — accepting callables for graph building, document loading, axis auditing, and sync checking — and produces SppfStatusConsistencyResult consumed by compliance_render. Without documentation, the dependency injection pattern and the callable signatures are invisible, making it impossible to understand how the audit pipeline is assembled without tracing imports through governance_audit_impl.py.

This subsystem is the coordination hub of the governance audit pipeline:

governance_audit_impl.py
    → sppf_audit.build_sppf_graph(build_graph=...)
    → sppf_audit.run_status_consistency(load_docs=..., axis_audit=..., sync_check=...)
    → SppfStatusConsistencyResult
    → compliance_render

Documenting it is required for the governance pipeline's coordination contract to be fully legible in the docflow graph.

Scope

  • Document the dependency injection pattern and all injected callable signatures
  • Document build_sppf_graph and run_status_consistency interfaces
  • Document SppfStatusConsistencyResult (violations, warnings merge strategy)
  • Position within the governance audit pipeline

Files

  • src/gabion_governance/sppf_audit/service.py
  • src/gabion_governance/sppf_audit/contracts.py
  • New: docs/sppf_audit.md

Metadata

Metadata

Assignees

No one assigned

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions