Definition of ready
Used in the playbook Quality and release. Also used in Definition of Ready
Download definition-of-ready.md — the source, as in the repository.
How to use
The template's own instructions:
UASK Engineering Hub template · definition-of-ready 0.2.0 · item process.definition-of-ready · playbook quality.quality-release (R2) · CC BY 4.0 This is the copy form of the checklist `process.definition-of-ready`, which is the one home of these lines; the number at the end of each line is its rule there (tests/check_repo.py checks that every rule appears). Copy to the project as DEFINITION-OF-READY.md and adapt: add lines of your own, remove none. Use it when picking work, not as a form to fill in: an item that fails a line is clarified, split or blocked before anyone starts it. Delete these comments in the copy.
Fields
Front-matter fields and sections of the document the template creates. A section marked Optional in the template may be deleted from a copy; every other field and section stays (tools/check_artifacts.py checks this for the kinds it knows).
| Field or section | Where | Required |
|---|---|---|
| A release is ready for Build (gate G2) when | section | required |
| A work package is ready to start when | section | required |
| This project only | section | required |
Example
A filled-in copy for an invented product, templates/examples/definition-of-ready.md, in the Hub repository.It shows the level of detail to aim for, not text to reuse.
# Definition of Ready — Fieldnotes
Version: 0.2.0 · Owner: Sam Roe · Last changed: 2026-03-01
## A release is ready for Build (gate G2) when
- [ ] The release spec is approved: by the lead, or by the owner when it changes the scope or the appetite or needs an owner-level decision. (R1)- [ ] The appetite is stated with what is left out if it is reached, and the package estimates do not add up to more. (R2)- [ ] The rollback is written, and for a live system the backup proved by restore is named. (R3)
## A work package is ready to start when
- [ ] The goal and the expected outcome are stated in the user's terms, not as a solution, and cite the requirement ids or the issue. (R4)- [ ] The Done criterion names the method, the environment, the expected result and who performs it, and can be performed there. (R5)- [ ] It fits one builder, one branch and one pull request, and has an estimate. (R6)- [ ] The files it may touch and must not touch are listed, and the checks to write first are named. (R7)- [ ] Dependencies, access, accounts and test data are available, or it is marked blocked. (R8)- [ ] Risk is noted: does it touch stored data, money, security, privacy or a public interface? If yes, the extra checks are named. (R9)- [ ] It is known how it will be verified: the test level and the command. (R10)- [ ] Decisions only the owner can make are made, or it is marked blocked. (R11)
## This project only
- [ ] A phone with the reference Android version is available for the manual check. (R12)Completion checks
A copy is complete when:
- every required field and section above is present, in the same order, and no bracketed placeholder is left;
- the template's comments are deleted from the copy;
- the exit criteria of its stage of the playbook Quality and release are met;
- the owner has approved it, where the playbook asks for approval. Only the owner sets
approved.
Source
templates/definition-of-ready.md, as in the repository. Placeholders are in square brackets; comments carry the instructions.
<!-- UASK Engineering Hub template · definition-of-ready 0.2.0 · item process.definition-of-ready · playbook quality.quality-release (R2) · CC BY 4.0 This is the copy form of the checklist `process.definition-of-ready`, which is the one home of these lines; the number at the end of each line is its rule there (tests/check_repo.py checks that every rule appears). Copy to the project as DEFINITION-OF-READY.md and adapt: add lines of your own, remove none. Use it when picking work, not as a form to fill in: an item that fails a line is clarified, split or blocked before anyone starts it. Delete these comments in the copy.-->
# Definition of Ready — [project]
Version: 0.2.0 · Owner: [name] · Last changed: [YYYY-MM-DD]
## A release is ready for Build (gate G2) when
- [ ] The release spec is approved: by the lead, or by the owner when it changes the scope or the appetite or needs an owner-level decision. (R1)- [ ] The appetite is stated with what is left out if it is reached, and the package estimates do not add up to more. (R2)- [ ] The rollback is written, and for a live system the backup proved by restore is named. (R3)
## A work package is ready to start when
- [ ] The goal and the expected outcome are stated in the user's terms, not as a solution, and cite the requirement ids or the issue. (R4)- [ ] The Done criterion names the method, the environment, the expected result and who performs it, and can be performed there. (R5)- [ ] It fits one builder, one branch and one pull request, and has an estimate. (R6)- [ ] The files it may touch and must not touch are listed, and the checks to write first are named. (R7)- [ ] Dependencies, access, accounts and test data are available, or it is marked blocked. (R8)- [ ] Risk is noted: does it touch stored data, money, security, privacy or a public interface? If yes, the extra checks are named. (R9)- [ ] It is known how it will be verified: the test level and the command. (R10)- [ ] Decisions only the owner can make are made, or it is marked blocked. (R11)
## This project only
- [ ] [project-specific condition, for example: design approved; content supplied by the client] (R12)