Definition of Ready #
Useful links: Jira Board, Confluence Space.
Before a task moves into active development in the aFP Design System, it must satisfy the following readiness criteria.
These conditions guarantee that development starts with clear requirements, approved design, and no blockers.
Purpose #
The Definition of Ready (DoR) ensures that every ticket or user story entering development is fully understood, scoped, and aligned with design, architecture, and business goals.
It prevents rework and confusion during implementation.
Ready Checklist #
- [ ] Jira ticket has a clear title and business value.
- [ ] Acceptance criteria are complete and testable.
- [ ] Designs attached or linked; states (hover/focus/disabled/error/loading) specified.
- [ ] API surface outlined (attributes, properties, events, slots, parts).
- [ ] Impact on generators/wrappers considered (e.g., Angular).
- [ ] Docs plan documented (which pages/examples to add or update).
- [ ] No blocking dependencies remain.
- [ ] Assignee and estimate are set.
General Criteria #
- The purpose of the task or component is clearly defined.
- The ticket includes acceptance criteria and expected outcomes.
- Dependencies (designs, data, APIs, libraries) are identified and available.
- The scope is small enough to complete within one sprint.
- The item has a defined owner and clear priority.
Design Readiness #
- UX and visual design are finalized and approved.
- Accessibility requirements (keyboard, color contrast, focus) are documented.
- The design uses existing tokens (colors, spacing, typography).
- All assets or icons are available in the shared library.
- Design-to-dev handoff is complete (Figma link attached).
Technical Readiness #
- The technical approach is agreed upon and documented.
- A suitable Plop generator (component, event, or theme) is identified.
- Required NPM packages or dependencies are available.
- No build or environment blockers remain.
- Potential impacts on other workspaces are considered.
Documentation #
- Related documentation pages are planned or outlined.
- Any required updates to the Eleventy docs site are identified.
- The story includes background context for new contributors.
- Team alignment achieved (reviewed by at least one developer and designer).
- A Jira link to the corresponding ticket is included and accessible.