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

Add team documentation to GOV.UK Design System team docs website #58

Open
12 of 24 tasks
kellylee-gds opened this issue Aug 7, 2023 · 2 comments
Open
12 of 24 tasks
Labels

Comments

@kellylee-gds
Copy link
Contributor

kellylee-gds commented Aug 7, 2023

What

Assess existing team documentation in the Google Drive which has value being made open. Also identify missing documentation.

Why

  • The team should not be dependent on any individual's knowledge and it should be shared
  • To work in the open and share good practice
  • Serves as proof of our processes

Epic lead

TBC

Who needs to work on this

Wave 1: Accessibility specialist, product manager, delivery manager

Prerequisites

How to get help from other roles

  1. CharlotteDowns Ciandelle
    christopherthomasdesign mia-allers-gds
  2. Katrina-Birch

Upcoming

  1. 0 of 7
    epic
  2. kellylee-gds
  3. kellylee-gds
  4. research ops
    Katrina-Birch

Ad hoc

  1. documentation
  2. documentation
  3. kellylee-gds
@dav-idc
Copy link
Contributor

dav-idc commented Aug 16, 2023

Initial thoughts on scoping:

Based on a timeline from now until end of Q2 (September 30)

Main sections, and what priority to aim for (1 is highest, 5 is lowest):

  • About these docs: 1
  • Who we are: 2
  • What we do: 2
  • How we work: 3
  • Principles: 2
  • Accessibility: 1
  • Community: 2
  • Delivery management: 4
  • Design and content: 4
  • Development: 3
  • Engagement: 5
  • Product management: 4
  • Support: 2
  • Technical writing: 4
  • User research: 4
  • Weeknotes: 5

@dav-idc
Copy link
Contributor

dav-idc commented Aug 21, 2023

A scoping session took place on Thursday, 17 August to figure out what portions of this work would be planned out for Q2 2023 (now until end of September 2023). Steve, Kelly and I were in that session. I believe a separate scoping session took place with Chris, but I don't have the notes from that session.

As far as I can recall, we agreed that the items marked as priority 1 above would be the scoped work for Q2.

Those items and their rationale for being priority 1 are:

  • About these docs
    • it's the homepage and sets the tone for the rest of the docs
    • items to add here:
      • disclaimer about the docs being a work in progress
      • licence and copyright information
      • purpose of the docs
      • set the tone
  • Accessibility
    • We're doing a lot of work with WCAG 2.2
    • There's team makeup reasons to prioritise the recording of accessibility process knowledge before Q3

Following that, the items marked as priority 2 would generally be the next to be worked on
The rationale for why these are marked as priority 2:

  • Who we are
    • a natural follow-up to the 'about these docs' content, and a lot of it is already written in other places
  • What we do
    • same as 'who we are'
  • Principles
    • this playbook is a better place to store our existing principles, and new ones coming from the coaching sessions
  • Community
    • one of the areas that affects all specialisations across the team
  • Support
    • one of the areas that affects most specialisations across the team

@romaricpascal romaricpascal transferred this issue from alphagov/govuk-design-system Jan 9, 2024
@36degrees 36degrees assigned 36degrees and unassigned 36degrees Jan 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

3 participants