Objective
Enable Playbooks to auto-add people to channels on incident start so that it saves user from repeating the same task.
Assumptions
Better organize playbook steps and stages so that they are easier to track during a workflow.
Enable preconfigured slash commands to be executed with any workflow step.
Enable users to create playbooks from an out-of-the-box sample so that it is easier to get started.
Figure out how to deploy to all future Cloud customers (ie. bundling, feature gates etc.)
Update UX to reflect the recent polishes.
Assumptions
Only deployed to Cloud alpha users.
Requirements
Must be able to… | User Story | Jira Issue | |
|---|---|---|---|
| 1 | Specify in the playbook a list of users to be added to the channel | As a playbook editor, I can specify the people and bots to get added every time so that it saves incident participants time when executing. | |
| 2 | Specify in the playbook a channel of which all members will be added to the incident channel | As a playbook editor, I can specify the list of people and bots to get added based on specific channel membership so that it can be dynamically determined based on the situation. |
| 3 | Send outgoing webhooks on change events | 4 | Expose documented REST API | 5 | Enable unrestricted developer use while requiring enterprise license for production use | As a developer, I can run the Incident Response plugin in my sandbox and consume its APIs so that it’s easy to build integrations. |
User interaction and design
Create stages when editing a playbook | As a playbook member, I can edit playbook to section the checklist of steps into stages so that a long list of steps is more manageable. | ||
| 2 | Set active workflow stage | As the workflow owner, I can change the stage that is currently active so that it is displayed by default for workflow members in the right-hand sidebar. | |
| 3 | View steps in stages during a workflow | As a workflow member, I can switch between the stages in the right-hand sidebar during a workflow so that I can review what has been done and coming up. | |
| 4 | Assign step owners | As a workflow member, I can assign a step in the workflow to a specific member so the allocation of responsibility is clear in the right-hand sidebar. | |
| 5 | Attach a slash command to each step when editing playbook | As a playbook member, I can define a slash command for each step so that when immediately performs specific tasks when the step is started during a workflow. | |
| 6 | Browse existing slash commands in playbook editing | As a playbook member, I can browse and select from existing slash commands to attach to a step so that I minimize chance of typos. | |
| 7 | Execute the attached slash command with a button click | As a workflow member, I can executed the slash command that is attached to a task with a click so that I don’t have to type out the required syntax. | |
| 8 | Browse sample playbook templates | As a team member, I can browse sample playbook templates so that I have a reference for how to use this feature. | |
| 9 | Create playbook from sample template | As a team member, I can create playbooks from sample templates so that I don’t have to start from scratch. |
User interaction and design
...
Open Questions
Question | Answer | Date Answered |
|---|---|---|
How/if doe the UI support the use cases of “I thought a step was complete but just found out it’s actually not”? | ||
How/if does the UI support the use case of “this step from the playbook turn out to be not relevant to the workflow. How do I get rid of it? (convo link) | ||
Since slash commands are effectively async, should we simplify step states to just yes/no for now? | ||
What level of Markdown support is there for playbook and step descriptions? | ||
Is the new design themed? | Yes |
|
When is the welcome modal shown to the user? | It is shown the first time user click on the plugin icon in the web app. |
|
Out of Scope
Enable users to repeatedly run the slash command for a workflow step via RHS.