How to use this documentation

Guidance on how to navigate and use this documentation effectively, from getting started to exploring modules and technical details.

This documentation is designed to help team leaders, IT, operations, HR, innovation teams, and partners configure, adopt, and extend Maecos. Operators themselves typically receive training inside a configured system, but operator flows are still described here to provide full context.

Structure of the documentation

• Introduction High-level overview of Maecos, its architecture, packages, and documentation usage.

• Getting Started Basics on access, login, navigation, and key concepts.

• Modules Each Maecos module explained in three parts:

  • Usage: how the module works in practice.

  • Configuration: how to set it up for your organization.

  • Best Practices: tips and common use cases.

• Implementation & Best Practices Guidance on rollout, sector-specific examples, and continuous improvement methods.

• Technology & Integrations Details on SSO, integrations, Node-Red, and API reference.

• FAQ & Troubleshooting Common questions, issues, and support contact.

How to read

• If you are new to Maecos → start with Getting Started.

• If you are an administrator or configurator → focus on Modules and Technology & Integrations.

• If you are planning adoption or rollout → explore Implementation & Best Practices.

• If you need release-specific updates → check the separate Release Notes site.

• For API details and developer use cases → see API Docs (currently under Technology & Integrations).