Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Document recommendations re: reference inclusion criteria and link styling in TTS Handbook / content guide #406

Open
1 of 9 tasks
Tracked by #416
, #381
...
MelissaBraxton opened this issue Jan 17, 2023 · 3 comments
Open
1 of 9 tasks
Tracked by #416
, #381
...

Document recommendations re: reference inclusion criteria and link styling in TTS Handbook / content guide #406

MelissaBraxton opened this issue Jan 17, 2023 · 3 comments
Labels
documentation Improvements or additions to documentation Guides Initiative 2 Tracks work for "Improving the Maintainability of the 18F Guides and Methods" Methods Task related to Methods and/or pulled from the old Methods repo.

Comments

@MelissaBraxton
Copy link

MelissaBraxton commented Jan 17, 2023 •
edited

Point of contact
@MelissaBraxton

Timeline
Does this need to happen in the next two weeks?

  • Yes
  • No

How much time do you anticipate this work taking?
About a week

Background
Following 18F/methods#568, we learned that the current content guide doesn't include specific guidance re: reference styling. This issue covers making updates to the content guide and/or handbook to include the reference inclusion criteria and styling guidance to help ensure consistency in how we're using and linking to references accross all of our products. You can find the styling guidance here:

Also, we recently implemented the same approach to header links as the TTS handbook (here's the PR for reference). We think other guides could also benefit from these changes, yet we had to do some digging to figure out what they entail--they're not well documented. This issue also covers writing up guidance on how to style perma header links in an accessible way.

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

  • Our reference recommendations are live in the TTS handbook and/ or content guide
  • Recommendations on how to make header links screen reader friendly are live in the TTS handbook and/or content guide.

Tasks

  • Decide where the reference guidance needs to live (What resource(s): TTS Handbook? 18F content guide?)
  • Write the styling considerations / guidance and/or instructions.
  • Create a PR to edit the resource and include our reference guidance
  • PO review
  • Accessibility review
@MelissaBraxton MelissaBraxton added the documentation Improvements or additions to documentation label Jan 17, 2023
@MelissaBraxton
Copy link
Author

MelissaBraxton commented Feb 13, 2023 •
edited

Updates the issue to also include recommendations for making header links accessible per the work done in 18F/ux-guide#373

@MelissaBraxton MelissaBraxton changed the title Document recommendations re: reference inclusion criteria and styling in TTS Handbook / content guide Document recommendations re: reference inclusion criteria and link styling in TTS Handbook / content guide Feb 13, 2023
@christophermather christophermather transferred this issue from 18F/methods Dec 22, 2023
@christophermather christophermather added the Methods Task related to Methods and/or pulled from the old Methods repo. label Dec 22, 2023
This was referenced Dec 22, 2023
Closed
Open
@christophermather christophermather added Initiative 2 Tracks work for "Improving the Maintainability of the 18F Guides and Methods" Guides labels Dec 22, 2023
@bpdesigns
Copy link
Member

@michelle-rago at the code owner of the Content Guide can you weigh in about the styling consideration above and if this should live in the content guide?

@michelle-rago
Copy link
Member

I'm not entirely clear on the scope of what is being asked here. Are we talking about how to style within-page headings and make them linkable? @bpdesigns

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation Guides Initiative 2 Tracks work for "Improving the Maintainability of the 18F Guides and Methods" Methods Task related to Methods and/or pulled from the old Methods repo.
Projects
18F UX Guide and Methods Shared Project
Status: Priority Backlog
Milestone
No milestone
Development

No branches or pull requests
4 participants
@bpdesigns @MelissaBraxton @michelle-rago @christophermather