Splice Documentation Should Be a View, Not a Document

Splice Documentation Should Be a View, Not a Document

Documentation

Written by

Lux Team

Category

Documentation

Date

Share this article

Why splice sheets rot

A splice sheet is usually a drawing — authored once, then maintained by hand as the network changes. Every change order, every field deviation, every emergency repair is supposed to flow back into the document. In practice it does not, and the sheet quietly diverges from the glass in the ground.

Illustration

Derive, do not draw

The alternative is structural: treat the fiber allocation itself as the source of truth, and render splice diagrams as views of that model. A diagram generated from the allocation cannot disagree with it. Change the design and every affected sheet updates, because there is nothing to update — the view re-renders.

Deviations are data

Field reality still diverges from plans, and that is fine — if deviations are captured as structured overrides on the model rather than pen marks on paper. The model then knows both the intent and the reality, and the delta between them is queryable instead of forensic.

The payoff at scale

Operators feel this most at handover and at fault time. Audits stop being archaeology. A technician tracing a fault reads a diagram that matches the closure in front of them. The documentation debt that normally compounds across a network simply never accrues.

Share Blog