|
68 | 68 | <h2 class="govuk-heading-l">Essential criteria</h2>
|
69 | 69 |
|
70 | 70 | <p class="govuk-body">
|
71 |
| - All contributions must meet these essential criteria to be considered for |
72 |
| - inclusion: |
| 71 | + The criteria for contributions vary depending on the stage of development. |
| 72 | + We follow a two-stage approach similar to other government design systems: |
73 | 73 | </p>
|
74 | 74 |
|
75 |
| - <h3 class="govuk-heading-m">1. Useful</h3> |
| 75 | + <InsetText> |
| 76 | + {#snippet content()} |
| 77 | + <strong>Stage 1:</strong> Criteria for proposing something new (moving |
| 78 | + from "To be developed" to "In progress")<br /> |
| 79 | + <strong>Stage 2:</strong> Criteria for completing development (moving to |
| 80 | + "Baseline completed" or "In use") |
| 81 | + {/snippet} |
| 82 | + </InsetText> |
| 83 | + |
| 84 | + <h3 class="govuk-heading-m"> |
| 85 | + Stage 1: Criteria for proposing something new |
| 86 | + </h3> |
76 | 87 |
|
| 88 | + <p class="govuk-body"> |
| 89 | + When you propose a new component or pattern, we'll check your proposal |
| 90 | + against these criteria before moving it to "In progress" status in our |
| 91 | + backlog: |
| 92 | + </p> |
| 93 | + |
| 94 | + <h4 class="govuk-heading-s">1. Useful</h4> |
77 | 95 | <p class="govuk-body">The contribution must:</p>
|
78 | 96 | <ul class="govuk-list govuk-list--bullet">
|
79 | 97 | <li>Solve a real user problem that's been identified through research</li>
|
80 | 98 | <li>
|
81 | 99 | Be needed by multiple teams or services, not just one specific project
|
82 | 100 | </li>
|
83 | 101 | <li>Address a gap in the current component library</li>
|
| 102 | + <li> |
| 103 | + Have evidence that it would be useful for many MHCLG teams, services, or |
| 104 | + other government departments |
| 105 | + </li> |
84 | 106 | </ul>
|
85 | 107 |
|
86 |
| - <h3 class="govuk-heading-m">2. Unique</h3> |
87 |
| - |
| 108 | + <h4 class="govuk-heading-s">2. Unique</h4> |
88 | 109 | <p class="govuk-body">The contribution must:</p>
|
89 | 110 | <ul class="govuk-list govuk-list--bullet">
|
90 | 111 | <li>Not duplicate functionality that already exists in the library</li>
|
|
96 | 117 | <li>Fill a specific gap in the current component ecosystem</li>
|
97 | 118 | </ul>
|
98 | 119 |
|
99 |
| - <h3 class="govuk-heading-m">3. Accessible</h3> |
| 120 | + <p class="govuk-body"> |
| 121 | + <strong>Evidence needed at this stage:</strong> Screenshots, links, or examples |
| 122 | + of where the proposed component has been used by other services, along with |
| 123 | + user research showing the need. |
| 124 | + </p> |
| 125 | + |
| 126 | + <h3 class="govuk-heading-m"> |
| 127 | + Stage 2: Criteria for completing development |
| 128 | + </h3> |
| 129 | + |
| 130 | + <p class="govuk-body"> |
| 131 | + After your proposal has been prioritised and moved to "In progress", but |
| 132 | + before it can be published with "Baseline completed" or "In use" status, |
| 133 | + we review it against these additional criteria: |
| 134 | + </p> |
100 | 135 |
|
| 136 | + <h4 class="govuk-heading-s">3. Usable</h4> |
| 137 | + <p class="govuk-body">The contribution must:</p> |
| 138 | + <ul class="govuk-list govuk-list--bullet"> |
| 139 | + <li> |
| 140 | + Show evidence of user research with a representative sample of users, |
| 141 | + including people with disabilities |
| 142 | + </li> |
| 143 | + <li>Demonstrate that the solution works effectively for real users</li> |
| 144 | + <li>Include usability testing results</li> |
| 145 | + <li>Work intuitively without extensive explanation or training</li> |
| 146 | + </ul> |
| 147 | + |
| 148 | + <p class="govuk-body"> |
| 149 | + <em |
| 150 | + >Note: If there isn't enough research yet to show that it's usable, a |
| 151 | + component can still be published with "In progress" status, but you must |
| 152 | + show relevant second-hand user research and it must meet the other |
| 153 | + criteria.</em |
| 154 | + > |
| 155 | + </p> |
| 156 | + |
| 157 | + <h4 class="govuk-heading-s">4. Accessible</h4> |
101 | 158 | <p class="govuk-body">The contribution must:</p>
|
102 | 159 | <ul class="govuk-list govuk-list--bullet">
|
103 | 160 | <li>Meet WCAG 2.1 AA accessibility standards</li>
|
|
114 | 171 | <li>Work without JavaScript (progressive enhancement)</li>
|
115 | 172 | </ul>
|
116 | 173 |
|
117 |
| - <h3 class="govuk-heading-m">4. Consistent</h3> |
118 |
| - |
| 174 | + <h4 class="govuk-heading-s">5. Consistent</h4> |
119 | 175 | <p class="govuk-body">The contribution must:</p>
|
120 | 176 | <ul class="govuk-list govuk-list--bullet">
|
121 | 177 | <li>
|
|
128 | 184 | <li>Follow consistent interaction patterns and behaviours</li>
|
129 | 185 | <li>Align with government design principles and service standards</li>
|
130 | 186 | <li>Use consistent naming conventions and terminology</li>
|
| 187 | + <li>Follow our content style guide for any guidance or documentation</li> |
| 188 | + <li> |
| 189 | + If there is code, it must follow our frontend coding standards and be |
| 190 | + ready to be merged into the component library |
| 191 | + </li> |
131 | 192 | </ul>
|
132 | 193 |
|
133 |
| - <h3 class="govuk-heading-m">5. Versatile</h3> |
134 |
| - |
| 194 | + <h4 class="govuk-heading-s">6. Versatile</h4> |
135 | 195 | <p class="govuk-body">The contribution must:</p>
|
136 | 196 | <ul class="govuk-list govuk-list--bullet">
|
137 | 197 | <li>Work across different types of government services</li>
|
|
142 | 202 | platforms)
|
143 | 203 | </li>
|
144 | 204 | <li>Be configurable for different use cases without breaking</li>
|
| 205 | + <li> |
| 206 | + Be tested and work with a range of browsers, assistive technologies, and |
| 207 | + devices |
| 208 | + </li> |
145 | 209 | </ul>
|
146 | 210 |
|
147 | 211 | <h2 class="govuk-heading-l">Technical requirements</h2>
|
|
0 commit comments