Skip to content
This repository has been archived by the owner on May 31, 2024. It is now read-only.

Remove outdated reference links and make link text for references consistent #588

Closed
6 of 8 tasks
MelissaBraxton opened this issue Jan 5, 2023 · 6 comments · Fixed by #599
Closed
6 of 8 tasks
Assignees

Comments

@MelissaBraxton
Copy link
Contributor

MelissaBraxton commented Jan 5, 2023

Background
There's currently a lot of variability in how we contextualize linked references from the Method cards. Eg, sometimes we include the title and author, sometimes just the title; sometimes the title is in quotes, sometimes it's not. This issue covers settling on a style for linked text, and then implementing it across all the methods.

This work builds on the work in #568 and is could also be coupled with #579, since it also entails touching every link.

Currently, it appears neither our 18F or GSA content guides have an opinion on this styling, so we should defer ti what AP says :)

Acceptance criteria (we'll know we're done when…)

  • How we contextualize links is consistent accross the Methods site
  • Links recommended for removal in this sheet have been removed

Tasks

  • Identify AP style guidance
  • Run proposed style by the content guild for feedback
  • Revise all references to match this guidance
  • Remove links recommended for removal
  • Consider suggesting an edit to the 18F content guide to clarify this style choice and maybe help other guides.
  • PO review [if task involves content changes]
@MelissaBraxton MelissaBraxton added content writing focused Relevant to other guides new issue use this to indicate an issue that needs refinement labels Jan 5, 2023
@MelissaBraxton
Copy link
Contributor Author

We may need an additional task or issue to cover actually changing the text, esp. if #579 is already done.

@MelissaBraxton MelissaBraxton removed the new issue use this to indicate an issue that needs refinement label Jan 10, 2023
@MelissaBraxton MelissaBraxton changed the title Make link text for references consistent Remove outdated reference links and make link text for references consistent Jan 11, 2023
@MelissaBraxton
Copy link
Contributor Author

Re: above comment, I think we're good on issues to cover this work. No new issues are needed, and this issue can move forward irrespective of #579.

@claireb-gsa
Copy link
Contributor

Proposing this format for references, and running by the content guild

[Title of item being referenced (no quotations, using sentence case)] – [en dash with spaces] [Name of publication (just title, not author names unless relevant)]

Examples:
Improving customer experience with digital personas – Digital.gov
Introduction to remote moderated usability testing, part 1: What and why – 18F Blog

@MelissaBraxton
Copy link
Contributor Author

Waiting on feedback from content guild on proposed styling.

@claireb-gsa
Copy link
Contributor

Content guild provided feedback on references - using em dash instead of en.

[Title of item being referenced (no quotations, using sentence case)] – [em dash with spaces] [Name of publication (just title, not author names unless relevant)]

Examples:
Improving customer experience with digital personas — Digital.gov
Introduction to remote moderated usability testing, part 1: What and why — 18F Blog

Outstanding question - where can this type of approach be documented? May be too specific for the Content guide.

@claireb-gsa
Copy link
Contributor

All links have been updated. Details of changes noted in audit spreadsheet.

Potential next steps
There are several cards that could use deeper looks - particularly to ensure that the concepts are still valid.

  • Design pattern library - should this connect to discussion of design systems?
  • KJ method - seems very niche - could connect to or be replaced by affinity mapping
  • Mental modeling - the content doesn't make the deliverable terribly clear
  • Multivariate testing - A/B testing seems like a more commonly known version of this - maybe mention? could help with search
  • Personas - replace with archetypes?
  • Style tiles -could connect to other visual deliverables - references outdated and removed
  • Task flow analysis - user flow? may need refocus, trying to explain what the deliverable is more clearly. Usability.gov is very confusing in how it describes actually doing this work - could use a lot of expansion

Possible additions

  • Experience mapping
  • service blueprinting

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Development

Successfully merging a pull request may close this issue.

2 participants