govuk-design-system icon indicating copy to clipboard operation
govuk-design-system copied to clipboard

Published 20 hours ago • verified publisher icon alphagov

Improve our internal documentation

Open kellylee-gds opened this issue 4 years ago • 1 comments

Body of epic to be completed after a kick off session

kellylee-gds avatar Dec 18 '20 13:12 kellylee-gds

What

A recent tech and ops health check identified areas in which we can improve our internal technical documentation particularly regarding knowledge management and findability

Why

  • To document any knowledge which currently exists in individual's heads
  • To make existing documentation visible to users where it is useful to do so

Who needs to know about this

Tech Writer, Developers

Further detail

GOV.UK Pay have externally documented processes such as support and contribution

Done when

  • [x] Review existing internal technical documentation and identify documentation which should be external #1432
  • [ ] Identify user groups, for example the team, new users, experienced users.
  • [x] Agree where to host external technical documentation #1433
  • [ ] Identify missing internal and external technical documentation #1434

kellylee-gds avatar Jul 12 '21 12:07 kellylee-gds

Going to be covered in https://github.com/alphagov/govuk-design-system/issues/2352

trang-erskine avatar Sep 15 '22 15:09 trang-erskine