How to turn issue requirements into an acceptance checklist
An issue checklist makes it easier to review whether the work addresses the requested behavior. Each item should trace back to an explicit requirement or a clearly proposed clarification.
Start with the right material.
- What you provide
- one issue with explicit requirements.
- The intended result
- Save a review checklist that maps each item to a supplied requirement.
How the workflow works.
Break the issue into observable checks and preserve any dependencies or exceptions. Separate implementation tasks from acceptance conditions so completing a task is not mistaken for proving the outcome.
What to check in the result.
Review unclear criteria with the issue owner before relying on the list. Keep all checks pending until someone has actually evaluated them against the implementation.
Preview the Markdown to check headings, lists and links as well as the words. Keep source references with the document so a reviewer can trace important statements back to the material you supplied.
Learn from the worked example.
The downloadable Markdown example shows one possible organization of the result. Read it alongside the source example and notice which statements are recorded facts, proposed wording or questions still needing an answer.
The supplied example is illustrative. It is not a recorded run on your data.
Download the example ↓Use it with your own material.
- Open the source you want to work with and activate WebAct on that tab.
- Copy the task from the hero, add any required fields or preferences, and review the proposed actions.
- Compare the first result with your source. Ask for a specific correction or refinement where needed.