Documentation Set#
The complete Critical Manufacturing MES documentation set is available in the online Critical Manufacturing Documentation Portal ↗. The local MES stack does not include a copy of the portal. It provides only instance-specific Reference documentation, which is available from Critical Manufacturing MES through the /reference route.
The online documentation set includes the following guides:
| Document | Target Audience | Description |
|---|---|---|
| User Guide | End users, application administrators, MES configurators, key users, and domain specialists | Describes the Critical Manufacturing MES graphical user interface and its functionality. |
| System Requirements | System administrators, infrastructure architects, cloud and platform engineers, IT procurement specialists, and pre-sales or solution engineers | Defines the prerequisites and supported configurations for installing and operating Critical Manufacturing MES. |
| Installation Guide | System administrators, DevOps and platform engineers, implementation consultants, partner deployment engineers, and database and infrastructure specialists | Explains how to plan, install, configure, upgrade, and remove Critical Manufacturing MES. |
| Operation Guide | System administrators, application administrators, SRE and operations engineers, database administrators, security administrators, and support engineers | Explains how to administer, maintain, secure, troubleshoot, deploy, and migrate Critical Manufacturing MES. |
| Tutorials | Key users, process and manufacturing engineers, training coordinators, functional analysts, and application configurators | Provides task-based guidance for configuring and operating Critical Manufacturing MES. |
Table: Guides available online
Note
The Developer Portal ↗ is also available online. It provides system integrators and developers with information about extending and customizing Critical Manufacturing MES, including the Design System, Data Dictionary, and API reference.
The documentation set also provides the following PDF documents:
| Document | File Name | Description |
|---|---|---|
| Installation Guide | InstallationGuide.pdf | A PDF export of the web-based Installation Guide. |
| Release Notes | ReleaseNotes.pdf | A description of the new features and changes in the release. |
| System Requirements | SystemRequirements.pdf | A PDF export of the web-based System Requirements. |
Table: Included PDF documents