Compliance documents

A controlled library for the supporting documents your programme writes — registers, templates, forms, plans and charters — each with a type, an owner, a version, a review cycle and its own review-and-approval lifecycle.

Policies and procedures have their own areas of Aegis. This library holds everything else your compliance work produces: an incident register, a corrective-action form, a business continuity plan, an internal audit checklist. A compliance document (a supporting record your programme authors, as distinct from a policy that binds people to a behaviour) is a titled piece of text with a type, an owner, a version and a review cycle. Each one moves from Draft through review to Approved, and every approval and revision leaves a numbered version behind.

Who uses it

Controls follow the permission rather than greying out — each is drawn only for a role that may use it. The library, detail and editing captures here were taken as a Contributor, and the creation page as a Manager (both roles see the same form), which is why no delete, approve or reject control appears. The library is a module your organisation has to have enabled; where it is not, opening a document returns you to the dashboard.

What's on this screen

Open /compliance-documents and the page loads in List view. The heading Compliance Documents sits top-left over a one-line description; on the right of the same header row sit a two-button view toggle — List and Grouped — and the dark-blue New Document button. Below the header runs a row of four dropdowns — -- Status --, -- Type --, All Levels and -- Framework -- — over a search box (placeholder Compliance Documents...) with a Search button beside it.

The table has seven labelled columns — Title (a link to the document), Type (a coloured badge), Framework (a badge, or a dash where none is set), Status (a badge), Level (a badge), Owner and Last Updated — plus an unlabelled column holding an eye-shaped view control. The captured screen shows a demo library across several frameworks — guides, forms, registers, plans and templates tagged ISO 27001, GDPR, DORA or NIS2 — at a mix of Draft, In Review and Approved, with tactical and operational levels and three different owners. The most recently updated document comes first, and the table pages in twenties.

Finding your way around the library

  1. Confirm which view you are in. List is selected on load and shows every document in one flat table; Grouped reloads the same documents as collapsible sections, one per governance level.
  2. Select New Document to add one. This is a full page, not a dialog — Aegis navigates to /compliance-documents/new, walked through in the next section.
  3. Narrow the table with the All Levels dropdown and its three neighbours. The level filter offers Strategic, Tactical, Operational and Unclassified — the last finds documents with no level set. The table redraws as soon as you choose, and the four filters stack.
  4. Type part of a title into the search box. The table reloads a moment after you stop typing, with the dropdowns still applied. Where nothing matches, it reads No results found over a Clear filters button, which empties the search box and leaves the dropdowns as you set them.
  5. Open a document with the eye-shaped view control at the end of its row, or by selecting its title. Both lead to the same detail page.
The compliance documents library in List view, with demo documents at Draft, In Review and Approved — /compliance-documents.
The compliance documents library in List view, with demo documents at Draft, In Review and Approved — /compliance-documents.
The grouped register view

Grouped loads the same documents as one collapsible section per governance level, each headed with a count. Unclassified documents form their own section, and an empty one reads No documents at this level. Not pictured here.

Three separate fields describe a document.

Field What it records Values
Type What kind of document it is Register, Template, Form, Notification, Plan, Charter, Methodology, Guide, Checklist, Standard
Status Where it sits in its review-and-approval lifecycle Draft, In Review, Approved, Retired
Level Its place in the governance hierarchy Strategic, Tactical, Operational, or Unclassified until one is set

Creating a document

Creation is a page of its own: /compliance-documents/new, headed Create Compliance Document under a breadcrumb back to Compliance Documents. Two cards sit side by side — Basic Information and Timeline — with a full-width Content card beneath. The Cancel and Create Document buttons sit at the foot of the page, below the edge of this capture.

  1. Enter a Title. It is required — submitting without one raises Title is required under the field, and nothing is saved.
  2. Choose a Type. It is required and starts on Register; the dropdown offers the ten types in the table above.
  3. Add a Framework tag if you want one. The first option is a bare dash — no framework at all — followed by every framework registered in Aegis, sorted by name (BSI C5, CyFun, DORA, GDPR, ISO 14001, ISO 27001, NIS2 and more). The list filter offers the same set.
  4. Set a Level, or leave it on Unclassified. The help text underneath spells out the choice — strategic sets direction, tactical translates it into standards, operational covers day-to-day execution.
  5. Below it, add an optional Category — a free-text label of up to 100 characters, shown later on the detail page.
  6. Under Timeline, set an Effective Date if you know it. The field reads dd/mm/yyyy until you fill it, with a calendar icon beside it. Below it, set the Review Cycle (days). It starts at 365 and accepts any whole number from 1 to 3,650, with days printed after the box.
  7. Write the body in the Content card — required, or Content is required appears. You type into a formatting editor, not a raw text box: undo and redo, bold, italic, a Block type selector for headings, three kinds of list, link, table, horizontal rule and full screen. The Preview tab shows the document as the detail page will render it.
  8. Select Create Document. A Compliance document created successfully confirmation appears and Aegis opens the new document's detail page — status Draft, version 1.0, you as its owner. Cancel returns to the library instead, discarding everything typed.
The full-page creation form — Basic Information and Timeline cards over the Content editor — /compliance-documents/new.
The full-page creation form — Basic Information and Timeline cards over the Content editor — /compliance-documents/new.

Reading a document

The detail page opens with a breadcrumb back to Compliance Documents, then the title with its type, framework (where set) and version beneath — Guide · v0.4 on the captured screen, which has no framework tag. The status badge, the lifecycle buttons for the current status and Edit Document sit opposite. Below, the page splits into a wide DOCUMENT BODY card and a narrower DETAILS panel, followed by VERSION HISTORY and the Collaboration panel.

  1. Check the status badge at the top right. It reads Draft on the captured screen; the badge is neutral for a draft, blue in review, green once approved and red when retired.
  2. Use the lifecycle button beside it to move the document on. On a draft it is Submit for Review; other statuses offer other buttons, set out in the next section.
  3. Select Edit Document to change the text or the fields. The button is drawn for Contributors and above, works only while the document is a Draft, and dims while an edit is already under way.
  4. Read the document in the DOCUMENT BODY card. The stored text is rendered, so headings, paragraphs, lists and tables appear as written — the captured guide shows a short introduction and two numbered sections.
  5. Check the DETAILS panel on the right: Owner, Type, Framework, Category (where one is set), Level, Review Cycle, Version, Effective, Created and Updated. Level is a badge, reading Tactical here; a dash against Framework or Effective means none is set.
  6. Look over VERSION HISTORY, headed with a count. The current version is the top row, marked Current with its author and date and time; every earlier snapshot sits beneath it. Select a row to expand it and see that version's stored text.
A draft compliance document in reading mode, with Submit for Review, Details and Version history — /compliance-documents/[id].
A draft compliance document in reading mode, with Submit for Review, Details and Version history — /compliance-documents/[id].

Scroll past the version history for the Collaboration panel — the comment threads and review requests raised on this document, the same threads Collaboration deep-links into. On the captured screen it reads No comments yet. over an Add a comment box. At the foot of the page sits the readable document identifier, such as ISO27001-CHR-001. Once a document has been through review, an Approval history card joins DETAILS, listing each step newest first — submitted, approved, rejected — with who acted, when, and any comment or reason they gave. This draft has none yet.

Comparing versions

With two or more versions in the history, a Compare versions box appears above the rows. Pick a from-version and a to-version — it starts on the latest snapshot against the current text — and Aegis shows a line-by-line difference, with added lines in green, removed lines in red struck through, and a count such as 3 added, 1 removed. Where a version was created by a revision, expanding its row also shows the Change summary given at the time. The captured document has a single version, so the comparison box is not shown.

Moving a document through review

The lifecycle buttons change with the status, and each is drawn only for a role allowed to use it. After every step the page refreshes with the new status badge, version and approval history, and a short confirmation appears.

Status Buttons offered What happens
Draft Submit for Review Contributor The document moves to In Review. Its text is locked from editing.
In Review Approve and Reject Manager; Return to Draft Contributor Approve opens an Approve document dialog with an optional comments box; confirming records you as approver, saves a snapshot and raises the major version (1.0 becomes 2.0). Reject opens a Reject document dialog whose Rejection reason is required, and sends the document back to Draft. Return to Draft withdraws it without a decision.
Approved Revise and Retire Contributor Revise opens a Revise Document dialog asking What is changing? — a summary is required. Create New Version snapshots the approved text, raises the minor version and returns the document to Draft for editing. Retire asks you to confirm Retire this document? It will no longer be considered current.
Retired Reopen as Draft Contributor The document returns to Draft so it can be reworked.

Approval rests on the permission alone: any Manager or Admin can approve or reject. Unlike Policies, there is no designated-approver setting for compliance documents. If someone else changed the document while your Revise Document dialog was open, Aegis refuses the revision and asks you to reload the page and start again, so one person's revision never silently overwrites another's.

Editing a document

Editing happens in place — no separate screen — and only while the document is a Draft. On any other status Edit Document is dimmed, and hovering it explains Document must be in Draft status to edit content. To change an approved document, use Revise first. Edit Document turns the body card into the same formatting editor as the creation page, with Edit and Preview tabs, and the DETAILS panel into a form; one Save writes both together. A note under the editor explains the keyboard: Tab moves to the next field, but inside a list it indents — press Esc, then Tab, to leave the editor.

  1. Amend the Title at the top of the DETAILS form. Clearing it and saving raises Title is required, and nothing is written — the same applies to an emptied body.
  2. Change the Type with its dropdown — the same ten types offered at creation. Below it, set or clear the Framework tag; its first option is a bare dash, storing no framework at all.
  3. Change or clear the Category. Emptying the box removes the category from the DETAILS panel.
  4. Set the Level; Unclassified clears any level set.
  5. Set or clear the Effective Date, and below it the Review Cycle (days) — any whole number from 1 to 3,650.
  6. Select Save at the top of the body card. The page returns to reading mode with your changes rendered, and a Changes saved confirmation appears.
Editing a draft in place — body editor on the left, DETAILS form on the right — /compliance-documents/[id].
Editing a draft in place — body editor on the left, DETAILS form on the right — /compliance-documents/[id].
Cancel discards your work without a prompt

Cancel, beside Save, leaves edit mode at once and throws away every unsaved change to both the body and the fields — no confirmation, no undo. Part-way through a long rewrite, save first.

Deleting a document

Deletion is open to Managers and Admins. The control is a bin-shaped button beside the eye on each list row, absent from these Contributor captures.

  1. Select the bin-shaped delete control on the row. A Delete Document confirmation dialog opens, naming the document in bold.
  2. Confirm to remove it, or cancel to keep it. The table refreshes without the row; if the delete fails, a Failed to delete document message appears and nothing is removed.

The empty state

Before anyone has written a document, List shows No documents yet over Add your first document to get started. — the header's New Document button is the way in. Grouped reads No compliance documents yet, over Create your first compliance document or seed templates from your framework. Neither view seeds anything on its own: a framework's document templates arrive only when they are ticked as Starter templates during setup or added later under Settings (see First-time setup), and then as Draft records to be reviewed. The documents in these captures are fictional demo data.

Tips and limits

Where this connects

For documents that bind people to a behaviour, see Policies and Procedures; for reusable starting points, Document templates. Comments and review requests surface in Collaboration, every change is recorded in the Audit log, and the permissions behind each control are set out in Roles overview.