How the portal is designed Level: Advanced
Service design and architecture
The design artefacts behind this portal: why it exists, how it will be tested with users, how it works and how each requirement is proved.
In brief
- Every requirement traces to the pages that meet it and the checks that prove it.
- The research plan says how each assumption could be proved wrong.
- The Service Standard rating is a self-assessment, not an assessment.
Theory of change
Departments must adopt the DAM Policy, but guidance for its three capabilities is spread across many pages and practitioner packs, so the same facts are recorded several times and returns are assembled late.
Inputs
- Published GOV.UK guidance behind the policy
- Practitioner playbooks for governance and quality
- Open standards (DCAT, MEM, DQV)
- GitHub for hosting, contact and automation
Activities
- Join the three capabilities into one method with one set of roles
- Give each role a route and a learning journey
- Check sources, accessibility and links automatically every week
Outputs
- One portal with step-by-step methods, templates and modules
- Open data versions of every requirement, template and term
- A public record of defects, open items and health
Outcomes
- Owners, records and DQAPs are set up once and reused
- Returns are built from catalogue records, not retyped
- Practitioners know which requirement each step meets
Impact
- Critical data assets are owned, findable and fit for use across government
- Services that rely on shared data, and the people they serve, are less affected by poor data
Assumptions to test
- Practitioners will use a single portal if it saves them effort (untested, OR-04)
- Hand-offs between capabilities reduce duplicate recording (untested)
- GOV.UK guidance remains the authority and changes are caught weekly
Research plan
Questions
- Can each role find the steps that apply to them in under two minutes?
- Do the hand-offs match how departments actually organise ownership, cataloguing and quality?
- Which sector supplements (DD-01 to DD-14) are needed first?
- Can people with access needs complete a route without help?
Methods
- Moderated usability sessions with 5 to 8 people per role, including people who use assistive technology
- Tree test of the navigation
- A survey through the Working Group
- Analysis of feedback received through the contact and feedback forms
Hypotheses and how they would be disproved
| ID | Hypothesis | Disproved if |
|---|---|---|
| H-01 | Routes by role reduce time to find the right step. | Median time to find a step is not lower on a route than through search alone. |
| H-02 | Recording the owner once and reusing it reduces mismatches. | Owner mismatches between register, record and DQAP do not fall after adoption. |
| H-03 | Learning modules improve confidence for new owners and stewards. | Self-rated confidence does not rise after completing the role's modules. |
Ethics and consent
Participants give informed consent, can withdraw at any time, and are recorded only with permission. Notes name roles, not people. No session collects data above OFFICIAL.
Service blueprint
| Stage | User action | Front stage | Back stage | Support process |
|---|---|---|---|---|
| Find | Searches or follows a link to the portal | Home page, role cards, search | GitHub Pages hosting; sitemap and metadata for search engines | Weekly health run keeps pages current |
| Learn | Works through modules for their role | Learning page, checks of understanding, progress | Progress kept in the reader's browser only | Content reviewed against GOV.UK sources each release |
| Do | Follows step-by-step methods and copies templates | Capability pages, templates, open data downloads | Content file generates every page and export | Build refuses broken references |
| Report | Builds the return and evidence pack | Policy spine, joined-up year, templates | Requirements and templates as CSV | Release notes record changes that affect returns |
| Improve | Reports a problem or suggests a change | Contact form, page feedback, Discussions | GitHub issue forms and Discussions | A person triages issues; fixes include a new check |
Requirements and traceability
Each requirement traces to the pages that meet it and the checks that prove it. Also available as CSV.
| ID | Kind | MoSCoW | Requirement | Met by | Proved by |
|---|---|---|---|---|---|
| FR-01 | Functional | Must | Show every DAM Policy requirement with its strength, source and the step that meets it. | dam | C-03, C-08 |
| FR-02 | Functional | Must | Give a step-by-step method for each capability with roles, templates and measures. | governance cataloguing quality | C-10, B-06 |
| FR-03 | Functional | Must | Offer a route and learning journey for each role, with progress the reader controls. | personas learning | B-10 |
| FR-04 | Functional | Must | Let anyone get in touch without an email address being published. | contact | C-04, C-14, B-09 |
| FR-05 | Functional | Should | Let readers search everything and filter every list. | index library knowledge | B-05, B-08 |
| FR-06 | Functional | Should | Publish the vocabulary, requirements and templates as open data. | library knowledge | C-11 |
| NFR-01 | Non-functional | Must | Meet WCAG 2.2 AA in light and dark modes, from 320 to 1920 pixels wide. | every page | B-01, B-02, B-03 |
| NFR-02 | Non-functional | Must | Work with scripts turned off and load nothing from other sites. | every page | C-05, C-12, B-07 |
| NFR-03 | Non-functional | Must | Label every fact with its provenance and keep sources current. | every page | C-08, HL-01 |
| NFR-04 | Non-functional | Must | Name roles, never people, and hold no personal data. | every page | C-04, C-17 |
| NFR-05 | Non-functional | Should | Be findable by search engines with accurate descriptions. | every page | C-16 |
| TR-01 | Technical | Must | Generate every page from one content file and refuse to build on a broken reference. | every page | T-VAL |
| FR-07 | Functional | Must | Show every capability the policy and adjacent guidance need, flagged explicit, implicit or inferred, with a signpost to the section it comes from. | capability-model | C-22, HL-02 |
| FR-08 | Functional | Should | Let organisations assess their maturity against the government model and DAM strands, keep the answers privately and download them. | capability-model | B-13, C-21 |
| FR-09 | Functional | Should | Link each role in the policy to government professions, framework roles, skills and learning routes. | professions | C-03, HL-01 |
| FR-10 | Functional | Must | Help organisations embed the policy in business as usual and in change programmes, with actions they can track. | change | B-08, B-10 |
| FR-11 | Functional | Should | Help readers find which sector supplements apply to an asset. | sectors | B-12, T-VAL |
| FR-12 | Functional | Should | Help readers find their way: a share menu on every page, a site map, a user guide with guided tours and tutorials. | guide site-map | C-31, B-16 |
| FR-13 | Functional | Should | Let organisations reuse the content through links, embedding, open data, AI assistants and an MCP server. | reuse data | C-28, C-31, C-32 |
| FR-14 | Functional | Should | Help organisations connect and buy data management tools without lock-in, with open standards and RFI questions. | tooling | C-33 |
| FR-15 | Functional | Should | Signpost the sister portals where they help, naming each and its status, without merging their journeys or copying their content. | quality tooling reuse | C-34 |
| FR-16 | Functional | Should | Help people who work across the three portals choose where to start, in what order and why, without merging the portals. | reuse | C-35, B-17 |
| FR-17 | Functional | Must | Let users take part in research privately, suggest and vote for ideas, and see the roadmap, backlog and how each item is prioritised against government strategy, in the open. | research | C-36, C-04, B-01 |
| FR-18 | Functional | Must | Let teams name people and work email addresses in their own copies of templates, and keep them out of anything published. | governance cataloguing quality library | C-38, C-04 |
| FR-19 | Functional | Should | Say whether each template is for business as usual, change or both, offer each template on its own, and offer logs used together as one tabbed workbook. | governance cataloguing quality library data | C-38, C-28 |
| FR-20 | Functional | Should | Give the data type, format, cardinality, controlled values and an example for every catalogue record property. | knowledge cataloguing | C-38, T-VAL |
| FR-21 | Functional | Should | Group each sector supplement's legislation, standards and frameworks by kind, and show how sector standards meet the catalogue standard. | sectors knowledge | C-38 |
| FR-22 | Functional | Could | Describe a critical data asset's entities, relationships and authoritative source, with a relationship diagram drawn from the list (issue 18). | sectors cataloguing data | C-39 |
| FR-23 | Functional | Should | Record retention schedule, period and disposal action in the ownership register and catalogue record, from the organisation's own schedule (issue 19). | governance cataloguing sectors | C-39 |
| FR-24 | Functional | Should | Give a data sharing agreement template covering lawful basis, legal gateway, retention and ending the sharing, and signpost the gateways (issue 20). | governance sectors | C-39 |
| FR-25 | Functional | Should | Show governance layers with the roles in each and what each may and may not change (issue 21). | governance data | C-39 |
| FR-26 | Functional | Should | Signpost health confidentiality gateways and medical device rules in the health and care supplement (issue 22). | sectors | C-39 |
| FR-27 | Functional | Should | Give glossary terms and named frameworks, methodologies and standards a tooltip and a link where they are first mentioned on any page, outside headings and existing links. | knowledge | C-40 |
| FR-28 | Functional | Should | List each capability's frameworks, methodologies and standards by kind on its Overview, and name the ones that apply at every step. | governance cataloguing quality | C-40 |
| FR-29 | Functional | Could | Drill down from each slice of the DAMA wheel to its activities and tasks where the portal has them, and publish what a fuller drill-down and a data architecture playbook would take (BL-35, BL-36). | capability-model | C-40 |
| FR-30 | Functional | Must | Take every capability in the capability model down to activities with steps, outputs, evidence, measures, who does what and a template. | capability-model change | C-45 |
| FR-31 | Functional | Should | Give people new to data asset management, or leading it, aims by priority, outcomes with indicators, and a plan for 30, 60 and 90 days with 6 and 12 month checkpoints against maturity levels. | personas | C-46 |
| FR-32 | Functional | Must | Reach the data portals compass and the asset governance explorer from every page, and keep the capabilities they show the same as the capability model. | every page capability-model | C-47 |
| FR-33 | Functional | Should | Give ready-made functional and non-functional requirements for each kind of tool, with a request for information, a requirements schedule, an evaluation method and contract clauses. | tooling data | C-48 |
| FR-34 | Functional | Should | Help learners learn, keep and share what they learn, link it to roles, careers and certifications, and download a learning record to use as CPD evidence. | learning | C-48 |
| FR-35 | Functional | Should | Recommend modules, activities and the next checkpoint by role, profession, organisation maturity and data literacy, reading the self-assessment where there is one. | personas | C-49 |
| FR-36 | Functional | Should | For every stage of designing and delivering a service, show the gates and assessments, the Service Standard points that touch critical data, what reviewers want to see and where the evidence comes from, linking to published guidance rather than repeating it. | change personas | C-50 |
| IR-01 | Integration | Must | Use only GitHub services (Pages, issue forms, Discussions, Actions and releases), plus an optional Microsoft Forms route for private feedback. | contact status whats-new | C-05, C-33, HL-01 |
Check prefixes: C static checks, B browser checks, HL the weekly health run, T-VAL build validation. Each is described on the About page and in the repository.
Solution architecture
Components
- AC-01 Content file
content/playbooks.yaml: requirements, methods, roles, personas, modules, sources and registers. - AC-02 Generator
tools/build.py: validates references, writes static pages, open data, sitemap, images. - AC-03 Front end
Static HTML and CSS with one progressive-enhancement script; no external assets; strict Content Security Policy. - AC-04 Checks
tools/check_site.py (static), tools/check_browser.py (Playwright with axe-core), tests/ (vaccinations). - AC-05 Health run
tools/health.py: GOV.UK Content API source dates, review date and page weight; results on the Status page. - AC-06 GitHub services
Actions (build, check, publish, weekly health, CodeQL, release), Pages, issue forms, Discussions, Dependabot.
Flows
- Change: pull request -> build -> static checks -> vaccinations -> browser checks -> review -> merge -> Pages
- Weekly: health run -> Status page -> issue labelled health if something needs a person
- Contact: contact form -> pre-filled GitHub issue form -> person sends it -> triage
Data
No personal data is held. Browser storage keeps progress and display choices on the reader's device only.
Service Standard self-assessment
| Point | Standard | Self-rating | Evidence |
|---|---|---|---|
| 1 | Understand users and their needs | Partly | Roles and needs drawn from practitioner material; research plan written, not yet run (OR-04). |
| 2 | Solve a whole problem for users | Partly | Joins three capabilities and the return; depends on GOV.UK guidance and departmental catalogues. |
| 3 | Provide a joined up experience across all channels | Partly | Links to GOV.UK, the Working Group and the Data Quality Commons; offline support not covered. |
| 4 | Make the service simple to use | Met | Routes by role, step by step, plain English, search; not yet tested with users. |
| 5 | Make sure everyone can use the service | Partly | Automated WCAG 2.2 AA checks pass; no testing with disabled users yet (OR-09). |
| 6 | Have a multidisciplinary team | Not yet | Built by one practitioner with AI assistance; no dedicated team (OP20). |
| 7 | Use agile ways of working | Met | Small releases, public changelog, issues and pull requests. |
| 8 | Iterate and improve frequently | Met | Weekly health run; feedback routes on every page. |
| 9 | Create a secure service which protects users' privacy | Met | No personal data, strict CSP, CodeQL, Dependabot, security.txt. |
| 10 | Define what success looks like and publish performance data | Partly | Success measures defined per capability; no usage data collected by design. |
| 11 | Choose the right tools and technology | Met | Static site on GitHub Pages; open standards; ADRs recorded. |
| 12 | Make new source code open | Met | Public repository under MIT; content under OGL. |
| 13 | Use and contribute to open standards, components and patterns | Met | DCAT, SKOS, DQV, JSON-LD; GOV.UK Design System patterns. |
| 14 | Operate a reliable service | Partly | Static hosting and health checks; single account dependency (OR-03). |
Was this page useful? Tell us Tell us privately, without GitHub