Manuals

Write, translate and publish digital operating manuals for your machines, deliver them by QR code and keep every version available for at least 10 years, as the EU Machinery Regulation requires.

In this section · 19 pages

• Manuals at a glance

  What the Manuals app does, how it is organised and how a manual travels from the first draft to the machine.

• Manuals list and creating a manual

  Find your manuals, see their state at a glance and create a new one.

• Editor tab: writing pages

  Build the page tree of a manual and write the content with automatic saving.

• Importing an existing manual

  Turn an existing PDF, Word, Markdown or text manual into pages.

• Versions tab: page history

  See every saved state of a page, compare changes and restore an older version.

• Translations tab: AI translation and review

  See the translation state of every page, translate with AI and review translations before release.

• Glossary tab: consistent terms

  Define how technical terms and signal words are translated in every language.

• Releases tab: publishing a version

  Freeze the manual as a numbered version, run the checks and publish the PDFs.

• Release details: PDFs, archive, compare and withdraw

  Download the PDFs of a version, see the archive copies, compare versions and withdraw a version.

• Sources tab: where updates come from

  Connect documents, software releases, support tickets and reader questions as sources for change proposals.

• Proposals: reviewing suggested changes

  Review the evidence and the changes of each proposal, edit it, and apply or reject it.

• Settings tab: manual settings

  Name, access, retention, branding, manufacturer, reader chat, access code and languages of a manual.

• Reader access: public, customers only or access code

  Control who can open a published manual after scanning the QR code.

• Machines and models

  Register machine types and serial numbers, place machines on the market and pin them to a manual version.

• QR codes and labels

  Show the QR code of a model or machine and print label sheets as PDF.

• The public reader: what readers see after scanning

  What an anonymous person sees when they scan the QR code on a machine.

• Reader chat: questions about the manual

  Let readers ask questions that are answered only from the released manual, with sources.

• Analytics and paper copy requests

  See how manuals are used, which questions stay unanswered and handle paper copy requests.

• Roles and permissions in Manuals

  Which built in role can read, write, approve and administer what.