Back to the laboratory

DAILYOPS / DOCUMENTATION AS CODE

Keep operational knowledge close to the systems it has to describe.

OpsDoc turns infrastructure snapshots into versioned Markdown documentation in Git, with explicit provenance (live or mock) and freshness states in place of silently stale pages.

THE OPERATING PROBLEM

Knowledge decays when nobody can tell what is still true.

Runbooks, topology notes and decisions drift from the systems they describe, and no one can say which page is still trustworthy.

WHAT THE SYSTEM MAKES POSSIBLE

OpsDoc / 03
01

Snapshot provenance

Every document carries its mode (live/mock), status, timestamp and snapshot ID — no hidden sourcing.

02

Freshness states

FRESH, DRIFTED, STALE, UNVERIFIED, SOURCE_UNAVAILABLE, MISSING, ERROR — the verify gate names what cannot be trusted.

03

One source, three surfaces

Generate, verify and read via the CLI, the API and the web UI; Git stays the source of truth.

VISUAL EVIDENCE

Documentation that stays part of the operating system.

Reserved for a documentation workspace, a freshness review and a graph view.

Screenshots will be placed here when they are ready.

BUILD POSITION

“A useful document changes with the work it supports.”

OpsDoc explores what documentation becomes when it is treated as an active, accountable part of operations.

RESOURCES

Explanation before repository.

Need a hand? I can help with guides and tech topics.