Author and format section content, save and verify changes, resolve concurrent edits and prepare a clear review hand-off.
Product location: /qms/{standardCode}/documents/{documentId} (fallback: /qms/standards). Review the document identity and choose Open Editor.
Open the intended QMS document and choose Open Editor, or choose Edit content in a section's reader panel. Confirm the document title, status and selected section. Reading requires View documents; saving content requires Manage documents. To change an approved, locked document, start a controlled revision.
Opening the full editor counts the document as worked with under your plan. Read any document-usage or allowance prompt before continuing; cancel if you only intended to inspect the document. Reopening an already-counted document uses the existing allowance entry. The document library, detail page and section reader provide reading entry points.
Product location: /qms/{standardCode}/documents/{documentId}/editor (fallback: /qms/standards). Use Document Outline to select the section; close unneeded side panels.
Use Document Outline to show or hide the section list. Expand the relevant parent, select the intended section and click within its content to place the cursor. Check the code and heading before editing. The outline identifies section types, optional sections and nesting.
A document with no sections needs a section structure first. Each section's Purpose and Content Structure / Template provide authoring guidance; write the working text inside that section's editor area.
Close unneeded side panels to give the document more room. The secondary toolbar opens related tasks:
Control | Use it when you need to |
|---|---|
AI Assistant | Ask for help with content through the assistant workflow. |
Track Changes | Review and decide on AI proposals. |
Version History | Inspect, compare or restore saved section revisions. |
Properties | Insert and maintain shared property tokens. |
Export Document | Create a file using the export options. |
Before opening a section-specific action, confirm the active section. Save your own work before restoring an earlier revision or moving to a task that replaces content.
Product location: /qms/{standardCode}/documents/{documentId}/editor (fallback: /qms/standards). Place the cursor inside the section and use the formatting toolbar or page-view controls.
Select existing text to format it, or place the cursor where you will type. Formatting controls act on the selected text or current block.
Control | How to use it |
|---|---|
Bold, Italic, Underline, Strikethrough | Select the relevant wording and toggle the style. Use the same control again to remove that style. |
H1, H2, H3, Normal text | Choose the block's heading level, or return it to a paragraph. Keep headings inside a section distinct from the section's own title. |
Bullet List, Numbered List | Use bullets for unordered items and numbers for a sequence. Enter continues the list; finish the list before starting a separate paragraph. |
Quote | Format a quotation or an extract as a separate block. |
Code Block | Present technical text in a distinct block where the content calls for it. |
Horizontal Rule | Insert a separator between parts of the section. |
Insert Table | Insert a three-by-three table with a header row, then replace the cells with meaningful headings and values. |
Insert/Edit Link | Select the label, enter or change its destination, and confirm. Check that the destination is correct for the intended readers. |
Remove Link | Remove the selected link while retaining its wording. |
Undo, Redo | Reverse or reapply a recent local edit. Review the changed content and save indicator afterwards. |
For example, use a bold opening phrase for Scope and a bullet list for Records to retain. For a procedure, choose a numbered list and make each item an action. Use a table when readers need to compare values across the same headings.
The Page selector offers A4 and Letter. Use the zoom buttons or the 75%, 100% and 125% presets to inspect the working view. When preparing a deliverable, also review the layout selected in Export Document and open the exported PDF or Word file to inspect tables, links and page breaks.
Product location: /qms/{standardCode}/documents/{documentId}/editor (fallback: /qms/standards). Edit the section, choose Save Draft and wait for Saved.
Choose Save Draft in the document header after a meaningful edit. Save in the formatting toolbar and Ctrl+S (Windows) or Cmd+S (Mac) also request an immediate save. Changes to multiple sections are saved as the sections' content.
Wait for saving to finish and for the unsaved-changes notice to clear. The header then shows Saved with the time of your explicit save; Auto-saved means the latest change was stored by an automatic save. An unchanged, freshly opened document normally has no active save action. If you keep typing while a save is in progress, allow the newer changes to finish saving too.
Use an explicit save before a deliberate review hand-off or a section-history comparison. Automatic saving keeps your working content current without adding a revision. An explicit save records a revision in Version History for every section changed since your last explicit save, including sections already stored by an automatic save.
Saving content keeps the document as working material until its review and approval workflow is complete. Use the separate approval and publication workflow when it is ready for controlled release.
Product location: /qms/{standardCode}/documents/{documentId}/editor (fallback: /qms/standards). After editing, stop typing and wait for Auto-saved before leaving.
After you pause typing for about two seconds, the editor queues an automatic save for the changed section. You can continue working, but check the save state before leaving the document. When several sections have changed, wait until all pending changes are saved.
For example, add Retention owner to a records list, stop typing and wait for Auto-saved in the header. Then reopen the section to confirm the new item. An automatic save should retain the same authored wording and formatting as an explicit save.
Use Save Draft when you want to finish a work session immediately. If you leave the editor while edits are unsaved or still saving, whether by Back, Close, another link or the browser's Back button, Leave the editor? tells you how many sections have unsaved edits. Choose Save and leave to save them first, or Stay to keep working. Choose Leave without saving only when you intend to lose those edits. If saving fails, the editor stays open with your edits and says so. Fix the problem and save again, or choose Leave without saving deliberately. Refreshing or closing the browser tab shows the browser's own warning instead.
Product location: /qms/{standardCode}/documents/{documentId}/editor (fallback: /qms/standards). Reload after a successful save and inspect the actual section content.
After saving, reopen the document when you need to confirm the persisted result. Check the actual wording, lists, links and tables in each changed section. For a substantial change, inspect its saved revision as well.
The completion indicator helps identify sections with content. Review accuracy, requirement coverage, outstanding feedback and approval readiness separately: a document can have text in every section and still need substantial review.
Document version, section revision history and document approval serve different purposes. Use the section history for saved content changes and the document's approval record for its controlled release. Follow the review workflow before presenting working text as approved guidance.
Product location: /qms/{standardCode}/documents/{documentId}/editor (fallback: /qms/standards). Preserve unsaved wording before reloading; compare it with the newest saved section.
A section can change in another session while your copy is open. A conflicting save protects the newer stored version and leaves your local wording to reconcile. Coordinate with other authors when you are working in the same section.
Keep a copy of your unsaved wording in an appropriate working note before reloading.
Reopen the document and read the latest saved section.
Compare the changes and agree which wording to retain if another author is involved.
Apply the agreed edits to the current section, save, and reopen to confirm the result.
For example, one author may clarify who reviews a record while another adds a retention requirement. Preserve both intended changes where they are compatible, instead of replacing the entire newer section with an older copy. Use Version History to understand saved changes when needed.
Product location: /qms/{standardCode}/documents/{documentId}/editor (fallback: /qms/standards). Select content within the intended section, replace or clear it, save and reopen to confirm.
Select the material within the intended section and replace it with the revised wording, or remove it when the section should be empty. Check the section heading and boundaries before selecting a large block of text. Save and reopen to confirm the exact result, including an intentionally empty section.
Clearing authored content keeps the section's identity and properties. If the section itself is no longer needed, use Delete section after reviewing children and requirement mappings. Review whether removing content changes the document's readiness or leaves a requirement unanswered.
Product location: /qms/{standardCode}/documents/{documentId}/editor (fallback: /qms/standards). Check the active section, save indicator and applicable permission or lock before retrying.
What you see | What to do |
|---|---|
Save is inactive | There is no unsaved change: either nothing has been edited, or an automatic save has already stored it and the header shows Auto-saved. Select the intended section and begin editing when a change is needed. |
Saving is still in progress | Keep the document open and wait for the result. Check the final state after your latest edit. |
Your edits could not be saved, so you are still in the editor. | Read the reason, correct it and save again. Leave without saving only if the edits are not needed. |
An unsaved or failed-save notification | Retain your wording, check connectivity and read the message. Retry once the reported cause has been addressed. |
A conflict with a newer version | Follow the conflict steps above using the latest saved section. |
Permission or approved-lock refusal | Check your document role or start the required controlled revision. |
A property-token validation message | Use the Properties controls to insert the intended token and check its definition and value. |
Before handing the document to a reviewer, confirm that each changed section is saved and that outstanding questions or feedback are visible in the appropriate review workflow. Continue with section discussions and document review.
