Skip to main content

Document metadata

Status
Maintained
Approval
Approved
Version
1.0
Classification
PUBLIC
Owner
Lightning IT Documentation Maintainers
Approver
Lightning IT Product Owners
Audience
documentation maintainers
Last reviewed
Next review
(Annual)

Technical documentation quality standard

Required content is correct, complete for its lifecycle phase, executable, unambiguous, maintainable, accessible, and evidence-linked. Complete commands, paths, commits, digests, and checksums are mandatory; abbreviations are not immutable references. Secret contracts describe names, presence, encryption, permissions, and validation outcomes without revealing values.

Every technical phase declares purpose, operation type, working directory, repositories, inventory, execution environment, guards, check/real/idempotency and verification commands, success marker, safe stop, restart, recovery, planned evidence, and actual result.