Task 4. Add inline documentation

Add inline documentation to Cortex XSOAR 8 SaaS playbooks.

When creating playbooks, it is a best practice to document your logic so others can follow your process. Inline playbook documentation makes this easy by displaying section header and task details directly within the playbook editor. This improves efficiency by clarifying the intent of each step and ensures workflows are understandable for anyone following the playbook. Playbook creators can attach specific guidance exactly where it is needed, such as adding warnings to individual tasks or summarizing grouped actions in section headers, making it easier to adopt and customize workflows.

How to access inline playbook documentation

1. Open the playbook you want to edit or review in the playbook editor. If the playbook is locked, duplicate or detach it to enable editing.
2. Click the Info mode toggle to set inline documentation view mode to one of the following.

   • None: Hides all inline documentation. Choose this for a clean, distraction-free view of the workflow blocks.
   • Headers: Displays only the documentation for Section Headers. This provides a high-level overview of the different phases of your playbook.
   • All tasks: Displays documentation for every task. This provides deeper insights into the specific logic and warnings for each step.
3. To edit header or task documentation, click the header or task you want to edit. Add details either directly in the editor or from the description in the header or task Details tab.

   Note

   You cannot add documentation to the top Playbooks Triggered task.

inline-playbook-documentation.png