In Practice

Common use cases for the Documents & Instructions module — from SOP management and approval workflows to retraining triggers and equipment-linked documentation.

Every document category in Maecos is fully configurable — its own approval flow, ownership model, access rights, and training connections. The use cases below show how different documentation scenarios map to platform functionality. Each is a category (or set of categories) that you define in Settings.

Complexity indicators: Start here = straightforward to configure, suitable for initial rollout. Intermediate = requires cross-module integration or multi-step approval flows. Advanced = depends on training integration, qualification gating, or mature platform usage.

Standard work documentation

SOPs and work instructions

Start here

Scenario: Production SOPs and work instructions need to be centrally managed with version control. When a procedure changes, operators must always reference the latest approved version — not a printout from last year's training binder.

How Maecos supports this: Configure a category for SOPs with an approval flow (e.g. author → quality review → production sign-off). Documents go through Draft → Approval → Effective. When a new version is approved, it automatically supersedes the previous one. Operators access the current version through the document portal, filtered by category, equipment, or label. The previous version is archived as Superseded — always accessible for audit, never shown as the active standard.

One-point lessons

Start here

Scenario: A team lead wants to capture a quick lesson learned — a better way to clear a jam, a visual guide for a tricky adjustment, a reminder about a common mistake. The lesson needs to be created fast, shared with the team, and findable later.

How Maecos supports this: Configure a One-Point Lesson category with a lightweight approval flow (single approver or no approval). Use the built-in online editor to create the lesson directly in the platform — no file upload needed. The document renders inline, so operators view it without downloading. Labels and equipment links make it searchable in context.

Policy and procedure library

Start here

Scenario: The organization maintains a library of corporate policies, HR procedures, and general guidelines. These documents change infrequently but must be version-controlled and accessible to all employees.

How Maecos supports this: Configure a Policies category with broad read access (all employees) and restricted authoring (HR, quality, or management). Approval flows can be simple — one approver per document. Use subcategories to organize by department or topic (Safety Policies, HR Policies, Quality Policies). The document portal gives employees a single, searchable entry point.

Approval and compliance workflows

Regulated document control (GMP, ISO, FSSC)

Intermediate

Scenario: Documents governing GMP, food safety, or quality management system compliance require formal multi-step approval — author, reviewer, quality sign-off — with full traceability of who approved what and when. Audit readiness demands a complete version history.

How Maecos supports this: Configure a Regulated Documents category with a serial or parallel approval flow. Approval groups define who reviews at each stage — with configurable quorum (e.g. 2 out of 3 quality managers must approve). Every approval action is logged with timestamp and user. The Scheduled status allows approved documents to take effect on a specific date — useful for coordinated rollouts. The full version trail — every draft, every approval, every superseded version — is retained and accessible.

Document-triggered retraining

Advanced

Scenario: When a critical SOP is updated — a cleaning procedure changes, a safety protocol is revised — all operators who work with that procedure need to be retrained before they can execute the new standard. This retraining should not depend on someone remembering to send an email.

How Maecos supports this: Link the document to a course in the Skills & Training module. When a new version of the document is approved and published, retraining is triggered automatically for all affected employees. Until they complete retraining, their skill qualification is flagged — and if qualification gating is active, associated checklists lock. This creates a closed loop: document change → automatic retraining → requalification → checklist access restored.

Scheduled document publication

Intermediate

Scenario: A new version of a plant-wide procedure has been approved, but it should only take effect at the start of the next quarter — after training sessions are completed and new materials are in stock.

How Maecos supports this: After approval, set the document to Scheduled status with a future effective date. The document publishes automatically on that date, superseding the current version. This allows coordinated rollouts where training, documentation, and execution all align on the same timeline.

Equipment and floor-level documentation

Equipment-linked documentation with QR codes

Intermediate

Scenario: Operators on the floor need fast access to machine-specific SOPs, cleaning procedures, and troubleshooting guides — without navigating a document portal or searching by title. The documentation should be accessible at the machine.

How Maecos supports this: Link documents to equipment items via the Equipment field. QR codes generated per equipment item link directly to all associated documents. Print and place the QR code on the machine — operators scan with a tablet or phone and see the relevant SOPs, work instructions, and reference guides. When documents are updated, the QR code automatically resolves to the latest version.

Workstation-specific documentation

Start here

Scenario: Different workstations within the same production area have different procedures — packing station A follows a different labeling SOP than packing station B. Operators need to see only the documents relevant to their workstation.

How Maecos supports this: Link documents to workstations via the Workstation field. When operators are logged in at a specific workstation, the document portal filters to show relevant documents first. Combined with category-based read access, this ensures operators see exactly the documentation they need — nothing more, nothing less.

Knowledge capture and distribution

Technical reference library

Start here

Scenario: The plant maintains technical reference documents — equipment manuals, supplier specifications, process flow diagrams — that are not SOPs but need to be version-controlled and findable. These documents are typically uploaded as files, not created in the editor.

How Maecos supports this: Configure a Reference Documents category with no approval flow (or a single sign-off). Upload files in any format — PDF, Word, Excel. Use labels for cross-cutting tags (e.g. "Supplier: X," "Equipment type: Packaging"). The document portal provides searchable access by category, label, and equipment.

External document links

Start here

Scenario: Some documentation lives in external systems — a supplier portal, a regulatory database, a corporate SharePoint. Rather than duplicating these files, the plant needs a single registry that includes both internal documents and external links.

How Maecos supports this: Create documents as external links — the document reference lives in Maecos (with category, owner, and metadata) but the content points to an external URL. This gives you a unified document portal without migrating files that are maintained elsewhere. Version control and approval flows still apply to the Maecos reference.

Document templates for consistency

Intermediate

Scenario: Multiple production lines create similar SOPs — cleaning procedures, startup procedures, changeover procedures. Each line's version should follow the same structure but contain line-specific details. Starting from scratch every time creates inconsistency.

How Maecos supports this: Define document templates per type or category. When an author creates a new document, the template provides the standard structure. Templates are maintained as documents themselves — when the template is updated, new documents created from it inherit the updated structure. Existing documents are not retroactively changed (they are independent after creation).