Check what a playbook does before you run it
Do this before you pick a playbook for a task, when you didn't write it yourself. A playbook's name and description rarely say everything: which experts it uses, which stages can change code, and which ones may stop to ask you something. All of that is on the playbook's own page, and reading it changes nothing.
Who can do this: anyone in your organization, on a plan that includes Playbooks. Without the Owner or Admin role the playbook opens read-only, with the note "You can view this playbook but not edit it.", which is all this guide needs.
- In the sidebar, select Settings, then Playbooks under Customize.
- Find the playbook. Type part of its name in Name or description, or select Tree view to browse by folder. Hover its name to read its description.
- Check the mark at the start of its row. โ means it is valid, ! means it has warnings, and โ means it has errors that someone with the Owner or Admin role needs to fix first (see Fix a playbook's errors).
- Select the playbook's name. It opens on the Playbook tab.
- Read the playbook's own fields. Full Auto set to On means no stage stops to ask questions; Off means stages that ask may stop and wait for you. Default seniority sets the model tier every stage uses unless it sets its own.
- Look at Chain. It draws the stages in the order they run. When some stages repeat for each planned item, the chain groups them into Prepare, Build ร N and Finish.
- Select the Stages (N) tab, then Expand all to open every stage card.
- On each card, read Expert and Deliverable for who does the work and what it hands back, and Waits for for what has to finish first. Asks questions reads Never asks for a stage that always runs straight through.
- Under Set by the deliverable, check Mode. Can change code marks a stage that opens a pull request; Read-only stages only read and report. Ends when says what finishes the stage.
- To see the exact instructions a stage's expert gets, select Preview prompt (๐ on a narrow card). Read the System and Task tabs, then select Close.
If the playbook does what you need, start your task with it: see Run a playbook on a task. If it's close but not quite right, an Owner or Admin can duplicate it and change the copy, as in Create a playbook.
Relatedโ
- How personas and playbooks work: what a stage, an expert and a deliverable are.
- Choose when a stage asks questions: how Full Auto and Asks questions decide when a stage stops for you.
- Playbooks: every stage field and fact.