LQMS User Guide¶
About this copy
The in-app manual is authoritative for your installation. These pages are built from the same Markdown at the version stamped in the footer; your LQMS ships its own copy, versioned with your release (ADR-0099). Where the two disagree, the manual inside your installation is right.
Task-oriented documentation for people using the QMS — distinct from the architecture and decision records, which explain how the system is built. Written for QMS users and quality managers; no development knowledge assumed.
Maintenance rule: every feature slice that changes user-visible behavior updates (or creates) its chapter here. Chapters cite the governing architecture decisions in a footer so deeper "why" questions have a trail.
Start here¶
New to LQMS? Tutorial — from zero to a released document is a hands-on, follow-along journey (register → configure → author → review → release → train → trace → operate) you can run step by step on the demo stack. The chapters below are the reference it links into.
Chapters¶
| Chapter | Audience | Status |
|---|---|---|
| Tutorial — from zero to a released document (the guided, follow-along path) | new users | current |
| The project context & app version (the toolbar switcher, the version badge) | everyone | current |
| Training & acknowledgements | everyone + quality managers | current |
| Documents & the lifecycle (draft → review → release → revise) | everyone | current |
| Recurring obligations (periodic duties with record evidence) | quality managers + responsible roles | current |
| Review comments | authors + reviewers | current |
| Diagrams (draw.io editor + Mermaid) | authors | current |
| Trace items (requirements, risks, risk controls, user needs, validation cases, design elements & regulatory references) | authors | current |
| Trace links & the suspect cycle (incl. validates & complies-with) | authors | current |
| The traceability workspace (coverage, chains, risk, training, validation & GSPR conformity) | everyone + quality managers | current |
| PDF exports & the audit pack (everything in a project, now) | quality managers | current |
| Administering an LQMS installation (the three altitudes, scope & user lifecycle, roles, when not to act, break-glass) | administrators | current |
| Technical dossiers (the curated, version-pinned technical file) | quality managers + regulatory affairs | covered by the technical-dossier topic below |
| Scope configuration (the gear menu) | quality managers | covered in training.md §4 (training/review policies), trace-items.md §1 & §7 (may-define governance, design-kinds vocabulary), emergency-cover (the cover matrix and its trail); + topics below |
| Search & references | everyone | planned |
| Admin: users, roles, invitations | administrators | covered by Administering an LQMS installation above, with the mechanics in the topics below (staffing & assignments, memberships, scopes, activity trail) |
Topics (the in-app manual, ADR-0099 — one question each)¶
The manual is becoming an in-app TOPIC reference (ADR-0099): self-contained pages, one question each, each bound to the screens it explains, the tutorial lessons it belongs to, and the screenshots it shows. Every topic below is written beside the surface it documents, and each is complete — none is a draft:
| Topic | Question |
|---|---|
| setup-wizard-lanes | What are the lanes, and what does the wizard actually write? |
| provisioning-birth-path | How is a new organization/project born? |
| staffing-and-assignments | How do I staff people — and what is the accountable holder? |
| review-policies | What does a review policy control, and what happens when a grant is empty? |
| key-rules | Which special elements does a project declare, and when do their names and prefixes freeze? |
| authority-view | Who holds each function here, and what may it do? |
| admin-scopes | How do I rename a project, and what can never change? |
| activity-trail | Who did what, when — reading a project's activity |
| technical-dossier | How do I assemble a technical dossier? |
| break-glass | The permission I need is held by a role I do not hold — what now? |
| emergency-cover | Who may cover for whom here, and where was break-glass actually used? |
| coverage-and-chains | Coverage or chains — which requirement view answers my question? |
| memberships | What does an invitation offer, and what does accepting actually change? |
| credentials | How do I change or reset my password — and why does LQMS never see it? |
The three-surfaces rule (orientation)¶
Training-related things live in exactly three places (ADR-0073):
- My training — personal: your obligations, your external trainings/certifications.
- Training compliance (in the Traceability workspace, for
VIEW_TRAINING_COMPLIANCEholders) — monitoring: compliance numbers, overdue lists, expiring certifications. - Scope configuration (the gear icon) — governance: the rules per document type.
If you are looking for "who must do what" → monitoring. "What must be done for this type" → governance. "What must I do" → personal.