> For the complete documentation index, see [llms.txt](https://docs.maecos.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.maecos.com/getting-started/readme.md).

# Maecos Documentation

The official Maecos documentation, covering configuration guides, best practices, and integration references for the unified operator platform.

This is the documentation for **Maecos**, the unified operator platform for process industry. It covers everything from first evaluation to advanced configuration, designed for team leaders, administrators, L\&D managers, partners, and integrators.

## Start here

{% columns %}
{% column %}
**New to Maecos?**

Get oriented with the platform overview, then jump into hands-on configuration.

→ [What is Maecos?](/getting-started/what-is-maecos.md)\
→ [Quick Start](/getting-started/quickstart.md)
{% endcolumn %}

{% column %}
**Configuring a module?**

Start with Core Concepts to understand the key decisions, then follow the Setup Guide.

→ [Reading paths by role](/getting-started/reading-paths.md)
{% endcolumn %}
{% endcolumns %}

## Modules

| Module                        | What it covers                                                                 | Start here                                                                               |
| ----------------------------- | ------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------- |
| **Issues & Logbook**          | Escalations, quality non-conformances, safety observations, investigations     | [Core Concepts](/issues-and-improvements/general.md)                                     |
| **Checklists & Planned Work** | Standard work execution, inspections, audits, compliance checks                | [Core Concepts](/standard-work-and-production/general.md)                                |
| **Documents & Instructions**  | Version-controlled SOPs, approval flows, retraining triggers                   | [Core Concepts](/documents-and-instructions/general-principles-docs-and-instructions.md) |
| **Skills & Training**         | Qualifications, skill matrices, courses, learning paths                        | [Core Concepts](/people-and-competence/general-principles-s-and-t.md)                    |
| **Evaluations**               | Performance reviews: self-assessment, team-leader conversation, sign-off       | [Overview](/people-and-competence/evaluations.md)                                        |
| **Downtimes**                 | Production stop logging, reason code trees, downtime analysis                  | [Core Concepts](/issues-and-improvements/general-1.md)                                   |
| **Meetings**                  | Daily management, meeting series, structured performance reviews               | [Core Concepts](/communication/general-1.md)                                             |
| **Updates & News Feed**       | Internal communication, announcements, targeted updates with read confirmation | [Core Concepts](/communication/general.md)                                               |
| **BOS / OFS**                 | Behaviour observations, safety compliments and improvement opportunities       | [Core Concepts](/issues-and-improvements/general-2.md)                                   |
| **Planned Activities**        | Planned production, maintenance, changeovers                                   | [Core Concepts](/standard-work-and-production/general-1.md)                              |
| **Product**                   | Master data: SKUs, materials, BOMs, and production orders                      | [Overview](/standard-work-and-production/general-2.md)                                   |
| **Maintenance (SAP PM)**      | SAP PM integration for maintenance notifications and work orders               | [Core Concepts](/standard-work-and-production/general-3.md)                              |

## Platform

Features that work across modules.

| Topic                      | What it covers                                                       | Start here                                     |
| -------------------------- | -------------------------------------------------------------------- | ---------------------------------------------- |
| **Equipment**              | Hierarchical equipment structure, the foundation for all modules     | [Equipment](/platform/equipment.md)            |
| **Actions**                | Cross-module action tracking, completion criteria, automatic actions | [Actions](/issues-and-improvements/actions.md) |
| **Dashboards & Reporting** | Configurable dashboards, widgets, and metrics                        | [Dashboards](/platform/dashboards.md)          |
| **Notifications**          | Notification templates, triggers, and per-module configuration       | [Notifications](/platform/notifications.md)    |
| **Labels**                 | Cross-cutting tags for filtering across modules                      | [Labels](/platform/labels.md)                  |

## Administration

| Topic                                                | What it covers                                                  |
| ---------------------------------------------------- | --------------------------------------------------------------- |
| [User Management](/administration/users.md)          | User accounts, login methods, teams, positions, reporting lines |
| [Roles & Permissions](/administration/roles.md)      | Role-based access control, permission model                     |
| [Settings](/administration/settings.md)              | Workstations, platform-wide configuration                       |
| [Security & Compliance](/administration/security.md) | Architecture, data protection, SSO, access control, GDPR        |

## Other documentation spaces

This site covers the Maecos product documentation. Two companion spaces are available:

→ [**Release Notes**](https://docs.maecos.com/release-notes)\
→ [**Developer & Integration Hub**](https://docs.maecos.com/developer-and-integration-hub)

## Need help?

If you have questions or require support, reach out to your internal Maecos administrator or contact our team at **<support@maecos.com>**.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.maecos.com/getting-started/readme.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `build a script that syncs our docs to a CMS` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.