[EPIC] Documentation changes for v13 release

[NoraGDS]

What

With the release of v13 of the Prototype Kit, all documentation on the website needs to be reviewed to identify changes and prioritise them.

Following the review, new content needs to be designed and drafted, considering outcomes from the private beta. https://docs.google.com/spreadsheets/d/1WRxf35hqzDDKYhERbkGbKF7kgthB1aXnDw04tLcvovo/edit#gid=144370392

Content changes: https://drive.google.com/drive/folders/16H5TG41aWA3bhA2MI9h9ZW98ub0tdV3I?usp=sharing

When content is signed off, it is to be published at the same time v13 is released publicly.

A decision on how to make content for v12 and before is also required #1542 .

Why

v13 of the Prototype Kit makes it available as an npm package replacing the need to download a zip file. It introduces a new interface to update, manage and build prototypes. As a result the current guidance will not be applicable - particularly around how to update, download and set up.

Who

Content designer and Interaction designer will lead this work.

Team to contribute and review guidance.

The Work

• #1493: Review PK update guidance - work was completed pre-v13 beta
• #1494: Publish PK update guidance
• #1461: Update backwards compatibility guidance - work was completed pre-v13 beta
• #1539: Review what documentation needs to change for v13
• #1644: make changes to High priority 1, 2, 3 guidance
• #1645: make changes to Medium priority guidance
• #1646: make changes to Low priority guidance
• user research on content - ideally new guidance
• #1540: Publish documentation changes for v13

Done when

• [x] Existing documentation is reviewed
• [x] Changes identified and prioritised
• [x] Review how to deal with #1493
• [ ] Review how to deal with #1494
• [ ] Review how to deal with #1461
• [ ] Documentation changes are made by priority -- [ ] High priority content -- [ ] Medium priority content -- [ ] Low priority content
• [ ] User research on changes
• [ ] Documentation changes are reviewed by team and agreed
• [ ] New pages created
• [ ] Pages updated
• [ ] Documentation changes are published

[lfdebrux]

Something to be added to the pile is documentation for developers of plugins, as @nataliecarey mentioned in dev catch-up today that will be important as things users used to be able to do will need plugins in v13.

[lfdebrux]

Some new documentation I just thought of, that I can't find in the existing tickets 😓:

• How to create new filters (not sure of priority)
• Use GOV.UK Notify (feels like low priority? Only a small change needed anyway to tell users to install the library from npm)

[NoraGDS]

Thanks @lfdebrux. Have updated the tracker spreadsheet with the new documentation. There is already a page on using Notify - do we need to update that? https://govuk-prototype-kit.herokuapp.com/docs/using-notify

[lfdebrux]

Thanks @lfdebrux. Have updated the tracker spreadsheet with the new documentation. There is already a page on using Notify - do we need to update that? https://govuk-prototype-kit.herokuapp.com/docs/using-notify

Yes, sorry, should have been clear, we don't need a new page, just to update the existing documentation, as in v13 an extra step to run npm install notifications-node-client is needed to before the code can be used in a prototype.

[lfdebrux]

We're pretty much ready to go on this 🎉 , amazing work @NoraGDS.

I've updated issue #1540 to link it to the v13 docs PR at alphagov/govuk-prototype-kit-docs#72, which is now ready to review.

[NoraGDS]

The work of this epic is completed. There was not enough time before release to do user research on the new guidance and this note is to mark that it still needs to be done.