-
Notifications
You must be signed in to change notification settings - Fork 8
Create design-history-template.md #214
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
Open
dannychadburn
wants to merge
1
commit into
main
Choose a base branch
from
newtemplate
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,53 @@ | ||
| --- | ||
| layout: page | ||
| title: Design history template | ||
| description: A three-act structure to use as a starting point for new posts. | ||
| eleventyNavigation: | ||
| parent: Guide | ||
| --- | ||
|
|
||
| Don’t forget to: | ||
|
|
||
| - draft as you go rather than after you’ve finished | ||
| - add tags so your post can be categorised and found | ||
| - follow the style and structure advice on the [writing for GOV.UK](https://www.gov.uk/guidance/content-design/writing-for-gov-uk) guide | ||
| - ask a content designer for support with structuring your doc or for a second pair of eyes (2i) prior to publishing – get help at [#screening-content](https://nhsdigitalcorporate.enterprise.slack.com/archives/C085GLW8Z70) on Slack | ||
|
|
||
| ## Title describing the activity | ||
|
|
||
| - Keep it succinct (8 words max.) | ||
| - Start with a present participle of a verb (designing, understanding, updating, improving, exploring, etc) | ||
|
|
||
| ## (Prologue) Subtitle intro | ||
|
|
||
| - Add a single sentence summary; “We `did a thing` so we could `reason for doing the thing`.” | ||
| - Write this in a way that someone with no prior knowledge of the subject could understand | ||
|
|
||
| ## (Act I - setup) Why we did what we did | ||
|
|
||
| - Outline the problem you’re trying to solve and the user story or needs it relates to | ||
| - Describe the nature of the problem (specific finding, recurring issue, etc) | ||
| - Explain how you identified it (data insight, during user research, etc) | ||
| - Use a few bullets to state the hypotheses you wanted to explore | ||
|
|
||
| ## (Act II - confrontation) What we did and how we did it | ||
|
|
||
| - Tell the ‘before and after’ story of design developments (“Users couldn’t do something. We made a change so now they can do this...and that.”) | ||
| - Explain how this addresses problems or improves user experience | ||
| - Go into detail, ideally in context with visual aids (screengrabs or recordings) | ||
| - Avoid including prototype or live service links – these evolve so may not match what people are seeing in the design history | ||
| - For all media, include descriptive alt-text and captions | ||
| - Describe why key decisions were made and alternatives that were considered | ||
| - Describe any difficulties or complications and how you tacked them | ||
| - If you’re showing more than one design workflow, separate these with the appropriate markdown headings | ||
|
|
||
| ## (Act III - resolution) What we learnt | ||
|
|
||
| - Provide details of any testing this design went through | ||
| - Include direct quotes where possible – these are powerful! | ||
| - Connect test outcomes to the hypotheses stated in the “Why we did what we did” section – were the assumptions validated? | ||
|
|
||
| ## (Epilogue) What we’re doing next | ||
|
|
||
| - Say what will become of this work (more iterations, more testing, pushing live, etc) | ||
| * Connect this up to other work you’re doing and explain how it fits into bigger plans | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Don't think all media need captions.