Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

📖 AP docs audit #6274

Open
YvanMOJdigital opened this issue Dec 11, 2024 · 0 comments
Open

📖 AP docs audit #6274

YvanMOJdigital opened this issue Dec 11, 2024 · 0 comments
Assignees
Labels

Comments

@YvanMOJdigital
Copy link

YvanMOJdigital commented Dec 11, 2024

User Story

As a…
I need/want/expect to…
So that…

Value / Purpose

No response

Useful Contacts

No response

User Types

No response

Hypothesis

If we... [do a thing]
Then... [this will happen]

Proposal

This issue should include the following tasks:

  1. Find and catalogue all AP technical documentation with relevant information (such as audience, location etc.).
  2. Work with team to understand which docs sets are in use and should be audited and what to exclude.
  3. Check usage data and metrics to get a basic understanding of user behaviour.
  4. Check user research for rounds or insights relevant to AP docs, including for the 'Find MoJ data' service.
  5. Assess documentation quality, looking at factors which include:
    • accessibility and compliance with WCAG 2.2
    • coherence of structure and headings
    • content clarity and effective use of plain English
  6. Write up report with relevant examples
  7. Create high level findings to share back to team with proposal for priorities.

Additional Information

No response

Definition of Done

  • Create an up to date catalogue of AP docs, shared and agreed by team
  • Write a report on documentation quality, shared with team
  • Create high level findings presentation with proposed priorities
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
Status: 👀 TODO
Development

No branches or pull requests

2 participants