Adding Steps to Playbooks
Each playbook consists of sequential steps that guide the user through a procedure.
Step Structure
Each step contains:
- Title - A brief, action-oriented heading
- Description - Detailed instructions for this step
- Commands (optional) - Terminal commands to execute
- Verification (optional) - How to confirm the step succeeded
Writing Good Step Titles
Tips for effective step titles:
- Start with an action verb (Check, Verify, Run, Open, Navigate)
- Be specific about what will be done
- Keep titles under 50 characters
- Avoid jargon when possible
Good Examples
- Check FreeSWITCH Service Status
- Restart the Audio Bridge
- Verify Recording Directory Permissions
Avoid
- Step 1 (too vague)
- Do the thing with FreeSWITCH (unclear)