Screen specification template
Copy this file for every permanent <MODULE>-SCR-<NUMBER> screen identifier. IDs never change when a screen is renamed.
Metadata
| Field | Value |
|---|---|
| Screen ID | MODULE-SCR-001 |
| Module | |
| Status | Draft / Review / Approved / Implemented / Deprecated |
| Platforms | Android phone / Android tablet / Web |
| Supported roles | |
| Route or destination | |
| Introduced in | |
| Last verified | YYYY-MM-DD |
| Source code | |
| Tests | |
| APIs |
Purpose and users
State the user outcome, primary roles and restrictions. List all valid entry and exit points.
Screenshot and anatomy
Embed the current approved seeded-data screenshot, then number each important region. Describe the purpose and reusable component/pattern for every numbered region.
Information hierarchy and actions
List what remains visible while scrolling. For every action document trigger, result, permission, confirmation, audit/analytics event, and whether it is reversible.
Interaction and states
Document default, loading, empty, search-no-results, validation error, network error, offline, permission denied, success, and partial-success behaviour where applicable. State what happens to user input after an error and how duplicate financial operations are prevented.
Data, API, validation, permissions
For each data source specify endpoint/schema, refresh and offline rule. Define field validation messages, role capability checks, audit events, and analytics properties without customer data.
Responsive, accessibility, and feedback
Define phone portrait, tablet, and desktop behaviour; Android back/header/gesture behaviour; focus order; screen-reader names; touch targets; dynamic type; keyboard support; reduced motion; loading, success, and error feedback.
Acceptance checklist
- Roles and entry/exit paths are correct.
- Default and exceptional states are implemented and documented.
- API, validation, audit, and analytics contracts are linked.
- Phone, tablet, web, light, and dark variants are verified where applicable.
- Current screenshots and automated flow are linked.
- User how-to and related workflow are current.