We completed a content review of all of the existing tutorials and guides in the service. There were consistent issues across the service that we can iterate and improve. This ticket is to track those improvements, rather than having lots of tickets on the backlog.
We will create individual tickets as we are working on the pages to track the actual changes.
Why
It makes sense to make our guidance clearer and easier to use for everyone.
Who needs to work on this
Content Designer
Done when
Each guide:
explains what technical terms mean
is clear and easy to understand (this applies more to older guides)
helps new users to learn advanced topics (some guides feel too concise)
provides opportunities to learn more about an unfamiliar topic
links users to the right place (for example, manage your prototype)
gives examples of where and why you might use something (make these specific to prototyping government services)
joelanman
commented
1 year ago
What
We completed a content review of all of the existing tutorials and guides in the service. There were consistent issues across the service that we can iterate and improve. This ticket is to track those improvements, rather than having lots of tickets on the backlog.
We will create individual tickets as we are working on the pages to track the actual changes.
Why
It makes sense to make our guidance clearer and easier to use for everyone.
Who needs to work on this
Content Designer
Done when
Each guide:
Pages
Download and install
Drafts here: https://docs.google.com/document/d/1zC5vuqxzB0PXmdVKxIuby8Jj244B-eStCoZFLRvUt34/edit
Get started
Drafts here: https://docs.google.com/document/d/1OG4Cw8Khw9tFWJ_Dbl2o8mKjWU1nT1xgMGKcTsUUGYY/edit
Basic usage
All drafts are within this folder: https://drive.google.com/drive/folders/1yy3qBidt9Jeog-Ddfo1z-M_amY5lJ50-
Advanced usage
All drafts are within this folder: https://drive.google.com/drive/folders/1Zg20_OmrxqxjsbAuvNq9Kij0PAgcOm4F