Document control and versioning
5 min
๐ฏ purpose the authoring and control rules for every document in this workspace consistent structure is what makes the workspace usable as an internal cms rather than a pile of files โน๏ธ governance principle this standard defines the minimum authoring and control requirements for operational documentation maintained in this workspace ๐๏ธ document types type prefix purpose review cycle overview none orients a reader in a space annual standard operating procedure sop the controlled way a process runs annual, or on process change work instruction work instruction keystroke level steps for one task annual, or on system change checklist none executable evidence artefact with its parent sop register / dictionary none controlled reference data continuous, with change process โ
mandatory elements every sop and work instruction states purpose, owner (one accountable role from the raci), sla or frequency where relevant, the procedure, and where its records go controls appear in the step where they operate, with their register id ๐ implementation guidance apply these standards consistently across sops, work instructions, registers, and checklists to preserve auditability, ownership clarity, and document traceability ๐งพ versioning rules documents are edited in draft and published deliberately; the published version is the version in force material changes (steps, controls, authorities) are announced at the ops review; editorial changes are not superseded procedures are archived, never deleted โ retention per the records retention standard โ ๏ธ control expectation material procedure changes affecting controls, authorities, or regulatory responsibilities must be communicated through the operational review process before publication โ๏ธ writing rules address the doer "validate the licence", not "the licence should be validated" one document, one job a procedure that needs a second purpose statement is two documents reference other documents by title and space, and reference registers by entry id, so links survive reorganisation
Have a question?
Our super-smart AI, knowledgeable support team and an awesome community will get you an answer in a flash.
To ask a question or participate in discussions, you'll need to authenticate first.