User Guide
This section provides step-by-step, enterprise-ready guidance for every major area of AtlasAI. Use it to onboard new users, run training, or look up how to complete a task.
What’s in the User Guide
| Guide | What you’ll learn |
|---|---|
| Users, roles & access | Step-by-step: invite, SSO/SCIM, roles (requester → admin), permissions, what the Settings UI does today |
| Self-service portal | Step-by-step: service catalog, submit requests, knowledge search; requester vs fulfiller |
| Workflows (ITSM vs automation) | Two workflow systems: when to use each, catalog workflow_definition_id, runbooks optional |
| Workflow builder (step-by-step) | Checklist: Definitions/Instances, Steps/Canvas/JSON, runbook chains, approval gates, report steps |
| Settings, users & RBAC | Map of Settings cards; links to the guides above |
| Using the interface | Command palette, responsive sidebar, forms and validation, charts and tables, error handling — how to navigate and work efficiently |
| Runbooks | Create, edit, approve, and execute runbooks; use variables and dynamic targets; generate from incidents |
| Scheduling & Automation | Set up automation schedules, cron-style triggers, and approval workflows |
| War Room & Major Incidents | Declare major incidents, run war rooms, post status updates, and manage stakeholders |
| Monitoring Policies | Create monitoring policies, add targets, define alert rules, and enforce collection |
| Dashboard Design | Build dashboards with widgets, template variables, and best practices |
How to use this guide
- New users: Start with Using the interface. Employees using only the portal: Self-service portal. Admins: Users, roles & access. Then Runbooks and Dashboard Design for ops value.
- On-call and SREs: Use War Room and Scheduling for incident response and automation.
- Platform admins: Use Monitoring Policies to define what gets monitored and how.
Platform behavior: For pagination (alerts, incidents, content packs), rate limiting (login, password reset), and retention policies, see What’s new — recent enhancements.
Each page includes step-by-step instructions, when and why to use features where relevant, and screenshot placeholders — add product screenshots to public/img/ using the filenames in each guide (see the repo apps/docs/public/img/IMAGES_README.md for the full list and capture instructions), and examples where applicable.