Guides
This section contains step-by-step guides for accomplishing specific tasks on the C_AI Platform.
What are guides?
Guides are task-oriented documentation that walk you through completing a specific goal. Unlike concepts (which explain how things work) or reference documentation (which provides technical details), guides focus on doing.
Guide structure
Each guide follows a consistent structure:
- What it is: Brief description
- When to use / when not to: Applicability
- Prerequisites: What you need before starting
- Steps: Numbered instructions to complete the task
- Example: Sample walkthrough with inputs and outputs
- Troubleshooting: Common issues and solutions
- Gotchas: Edge cases and surprises
- Related links: Further reading
Available guides
| Guide | Description |
|---|---|
| Portal User Workflow | End-to-end process for submitting evidence and reviewing assessments |
| Admin Workflow | Platform configuration and monitoring for administrators |
| Evidence Submission and Mapping | Preparing, uploading, and optimizing evidence documents |
| Reviewing Results and Responses | Interpreting assessment outcomes and taking action |
Contributing guides
If you are writing a new guide, see the Style Guide for formatting requirements and the Examples & Patterns page for templates.