Page Template
is section MUST describe the page shortly
It MUST include a QA part as below with the correct link.
This section MUST include a screenshot of the Page
This section COULD include other screenshots of the page depending of the configuration (ex: B2B, Multistore ). Those screenshots MUST be labelled (ex : B2B ) for further uses ( see below)
The screenshot COULD include some labels or numbers to some UI component if needed. So you can refer to this "label" bellow.
QA
Components description
This section MUST describe each component one by one
A component description
Several cases
1) The component is a common UI / UX (for example "Help button"): It MUST be a link to this common components (we recommend creating a dedicated change request when adding a new common component to the documentation)
2) The component is a common component with a standard behavior described in the UI/KIT or Design System : it must be a link to the UI/KIT or DS
3) A chart like example belows
Contacts table
| Filter Rules | Value | |
|---|---|---|
ID | Numeric_filtering | Textfield |
Social title | Social Title (list of social title available) | Dropdown list |
First name | Alphanumeric_sorting | Textfield |
Last name | Alphanumeric_sorting | Textfield |
Email address | Alphanumeric_sorting | Textfield |
Group | Group ( list of groups available) | Dropdown list |
Sales | Numeric_filtering | Textfield |
Enabled | Boolean_filtering | Dropdown list |
Newsletter | Boolean_sorting | Dropdown list |
Partener offers | Boolean_sorting | Dropdown list |
Registration | Between 2 Timestamp | 2 dates picker |
Last visit | N/A | N/A |
4) Otherwise the component MUST be described as a Table as described bellow
| Description | Value | Error message |
|---|---|---|
Mandatory | YES/NO | The Zip/Postal code is invalid. It must be typed as follows: |
Allowed/Forbidden values | ||
Default value | Default value | - |
Help text | Help text | - |
Tool tips | Tool tips text | - |
Lower limit | ||
Upper limit | ||
Behavior | - |
This section COULD contains label (ex: multishop ...)
Behaviors description
This section MUST contains :
A section with the whole picture of the behaviors and worfkow
For each behavior, a sub section that describes it
Workflow
This sub-section MUST describe the page workflow
This sub-section MUST include a diagram of this worflow (using : https://app.diagrams.net/ or figma ) & the xml export of this workflow
Behavior description
This sub-section MUST contains the description of the behavior / call to action.
This sub-section COULD contains a link to the relevant business rule
This section COULD contains label (ex: multishop case ...)
Error messages
This section COULD list all errors messages / Exceptions for the page / workflow
Limitations
This section SHOULD list limitations of the page.
Last updated
