Appearance
Controlled document
Also known as
- new document
- document revision
- change summary
- submit revision
- approve document
- effective date
- distribution list
- acknowledge
- read and sign
- compare revisions
The document page holds the document's attributes, its revisions with their approval and effective dates, a comparison between revisions and the acknowledgements of the distribution list.
Create a document
- Open QualityDocuments and select New document.
- Under Document, enter the Title and choose the Type (Procedure, Work instruction, Form, Policy, Specification, Manual, Record, Other), the Department and Owner.
- Set the Review interval in Months (default from General) and the Distribution list: the users who must read and acknowledge each effective revision.
- Under Revision A, enter the Change summary (for example Initial issue), the Effective date (empty = effective as soon as approved) and the Content.
- Select Create document. The message Document QD-… created appears; revision A is a draft.
Revise a document
- On an effective document, select New revision. The next letter (B, C …) starts with the current text (New revision started).
- Edit the Content, write the Change summary and set the Effective date.
- Select Save revision to keep your work, or Discard draft to drop it.
- Select Submit for approval (needs Permission:
quality.document.submit). Content and a change summary are needed.
⚑ Approval
Document revisions follow the Document revision rules in Approval rules (conditions: document type, department, revision; in the demo company every revision goes to the administrator). Approvers act in Approvals. While pending, the section says Waiting for approval. Recall it to make further changes. and Recall returns it to draft.
An approved revision becomes Effective on its effective date (the daily job, or at once when the date is today or earlier); the previous revision becomes Superseded and everyone on the distribution list is asked to acknowledge it.
Acknowledge a document
- Open the document from the Waiting for your acknowledgement banner or from QualityOverview.
- Read the Effective text (revision …). The banner says Please read revision … and acknowledge it.
- Select Acknowledge (needs Permission:
quality.document.acknowledge). Acknowledgement recorded appears.
Acknowledgements lists each User with Pending or Acknowledged and the date.
Compare revisions
Under Revision comparison, choose Compare and With. Lines are marked Added, Removed or Unchanged, with a summary Revision … → …: … lines added, … removed. Revisions lists every revision with its status, Effective date, Change summary and Approved by.
Make obsolete or reinstate
- Make obsolete withdraws the document with a Reason; open revisions are discarded. The banner reads This document is obsolete: ….
- Reinstate brings an obsolete document back.
PDF prints the current revision.
Differences by role
- Editing and new revisions need Permission:
quality.document.manage. Everyone withPermission:quality.document.viewcan read effective documents.
