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.

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

Fix broken links in the guides #763

Merged
merged 10 commits into from
Dec 11, 2024
1 change: 0 additions & 1 deletion content/accessibility/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,6 @@ Please see [our tools page for a listing of accessibility testing tools](tools/)
* [WebAIM's Blog](http://webaim.org/blog/)
* [The Accessibility Project](https://a11yproject.com/) - Good accessibility blog.
* [Knowbility's Blog - WCAG 2.2 Series](https://knowbility.org/blog/2022/whats-new-in-wcag-2-2)
* [Simply Accessible](http://simplyaccessible.com/archives/) - A great blog and resource with articles about modern accessibility.
* [WebAIM's Accessibility Resources](https://webaim.org/resources/)
* [Tips for creating Accessible SVGs](https://www.sitepoint.com/tips-accessible-svg/)
* [Udacity Web Accessibility Course](https://www.udacity.com/course/web-accessibility--ud891) - Free web accessibility course by Google
Expand Down
12 changes: 4 additions & 8 deletions content/content-guide/our-approach/be-concise.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,9 +39,7 @@ Words ending in *–ion* and *-ment* tend to make sentences longer and more comp

## Keep sentences short and sweet

Craft sentences at 25 words or fewer, whenever possible. If a sentence has fewer than 14 words, [readers understand 90 percent of content](http://comprehension.prsa.org/?p=217). At 25 words, sentences are markedly more difficult to comprehend.

We also recommend varying sentence length. Switching things up helps you keep readers interested. This tactic will also give you better control of your content’s [tone]({{ "/content-guide/our-style/voice-and-tone/" | url }}) — a text with only short sentences can unintentionally sound terse. The occasional longer sentence adds a bit of narrative interest (and can help a piece of writing sound friendlier, too).
Express only one idea in each sentence. Try to keep sentences at 25 words or fewer. Resist the temptation to put everything in one sentence.

Here’s an example of how you might transform a too-long sentence into something more manageable.

Expand All @@ -53,9 +51,7 @@ Use:

> Unfortunately, we can’t replace lost or stolen passes. [Get a new pass on our website](https://www.recreation.gov/pass/).

## Additional resources
- [Plainlanguage.gov: Write short sentences](https://www.plainlanguage.gov/guidelines/concise/write-short-sentences/)
- [Gov.UK writing guide: Be concise](https://www.gov.uk/guidance/content-design/writing-for-gov-uk#be-concise)



---

_Thanks to [GDS](https://www.gov.uk/guidance/content-design/writing-for-gov-uk), whom we looked to for inspiration when writing this page._
2 changes: 1 addition & 1 deletion content/content-guide/our-style/inclusive-language.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ Use descriptors of gender identity or sexual orientation as modifiers, not as no
- Avoid _guys_ as a way to refer to mixed-gender groups.
- Don't make assumptions about marital or family relationships (for example, use _spouse_ or _partner_ instead of _husband_ and _wife_; use _parent_ instead of _mother_ and _father_).

For more detailed guidance, see the [National Lesbian and Gay Journalists Association Style Guide](http://www.nlgja.org/stylebook/terminology/) or the [GLAAD Media Reference Guide](https://www.glaad.org/reference/).
For more detailed guidance, see the [National Lesbian and Gay Journalists Association Style Guide](https://www.nlgja.org/stylebook-on-lgbtq-terminology/) or the [GLAAD Media Reference Guide](https://www.glaad.org/reference/).

## Nationality

Expand Down
2 changes: 1 addition & 1 deletion content/engineering/about/resources.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,4 +30,4 @@ This guide evolved from work spearheaded by the 18F Engineering Chapter and the
- [Cloud.gov Production-ready guide](https://cloud.gov/docs/deployment/production-ready/)
- [Login.gov Identity Playbook](https://login.gov/playbook/)
- [Digital.gov Guides and Resources](https://digital.gov/resources/)
- [GSA Tech Guides](https://tech.gsa.gov/guides/opensource/)
- [GSA Tech Guides](https://tech.gsa.gov/guides)
2 changes: 1 addition & 1 deletion content/engineering/tools/accessibility-scanning.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ Install pa11y locally:

Create a `.pa11yci` in the root of your directory to [configure your pa11y CI run](https://github.com/pa11y/pa11y-ci#configuration). This step is optional, but helpful if you want to change any default configuration.

For an example, take a look at the [18F guides site's .pallyci file](https://github.com/18F/guides/blob/main/.pa11yci).
For an example, take a look at the [18F guides site's .pa11yc.jsi file](https://github.com/18F/guides/blob/main/.pa11yci.js).

Create a `.github/workflows` directory in the root of your project, and then add a file `accessibility-scan.yml` (or whatever you want to call it).

Expand Down
2 changes: 1 addition & 1 deletion content/methods/discover/system-map.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ method:

## Additional resources{#add-system-map}

- [The VA Community Playbook](https://department.va.gov/veterans-experience/wp-content/uploads/sites/2/2022/10/va-community-playbook.pdf), pages 12 and 13, The Department of Veterans Affairs
- [The VA Community Playbook](https://department.va.gov/veterans-experience/wp-content/uploads/sites/2/2024/06/Community-Playbook_update_508_FINAL.pdf), pages 12 and 13, The Department of Veterans Affairs
- [Example systems map](https://www.gov.uk/government/publications/systems-thinking-for-civil-servants/toolkit#iterative-and-cyclical-flow-of-the-toolkit), gov.uk
- [An introductory systems thinking toolkit for civil servants](https://www.gov.uk/government/publications/systems-thinking-for-civil-servants/toolkit#introduction-to-systems-thinking), gov.uk
- [A brief overview of systems mapping](https://mojdigital.blog.gov.uk/2020/06/02/systems-mapping-a-brief-overview-of-what-why-and-how-part-1/), gov.uk
Expand Down
2 changes: 1 addition & 1 deletion content/ux-guide/our-approach/defining-design.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ Products and services impose requirements on the organizations that support them

## Design is never done

We don’t have all the answers. And that’s okay. We take an iterative, cyclical, participatory, [lean]({{ '../../our-approach/stay-lean/' | url }}) approach. We try things out and learn from them. We commit to continuous improvement using critiques, [wireframes](https://guides.18f.gov/methods/make/wireframing/), [prototypes](https://guides.18f.gov/methods/make/prototyping/), [usability tests](https://guides.18f.gov/methods/usability-testing/), service blueprints, etc. and we strive to build the capacity of our partners to do the same.
We don’t have all the answers. And that’s okay. We take an iterative, cyclical, participatory, [lean]({{ '../../our-approach/stay-lean/' | url }}) approach. We try things out and learn from them. We commit to continuous improvement using critiques, [wireframes](https://guides.18f.gov/methods/make/wireframing/), [prototypes](https://guides.18f.gov/methods/make/prototyping/), [usability tests](https://guides.18f.gov/methods/validate/usability-testing/), service blueprints, etc. and we strive to build the capacity of our partners to do the same.

{% image_with_class "assets/ux-guide/iterative-design.png" "" "A conceptual image that describes iterative design. The phrase 'iterative design' is surrounded by four labels connected by a circle of clockwise-pointing arrows. Starting at the top, the labels read 'concept', 'try it out', 'gather feedback', 'incorporate feedback" %}

Expand Down
2 changes: 1 addition & 1 deletion content/ux-guide/research/legal.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ subnav:
href: '#additional-questions'
---

18F designs our research to account for the [The Paperwork Reduction Act of 1995 (PRA)](https://pra.digital.gov/), among other laws. This article summarizes what we’ve learned through conversations with [GSA’s Privacy Office [GSA.gov]](https://www.gsa.gov/reference/gsa-privacy-program) and [GSA’s Office of General Counsel [GSA.gov]](https://www.gsa.gov/about-us/organization/office-of-general-counsel-overview).
18F designs our research to account for the [The Paperwork Reduction Act of 1995 (PRA)](https://pra.digital.gov/), among other laws. This article summarizes what we’ve learned through conversations with [GSA’s Privacy Office [GSA.gov]](https://www.gsa.gov/reference/gsa-privacy-program) and [GSA’s Office of General Counsel [GSA.gov]](https://www.gsa.gov/about-us/organization/office-of-the-general-counsel-overview).

*Disclaimer: This article is intended for internal use. It’s shared in the spirit of open source, to prompt conversations around design research as it relates to the law. GSA has no regulatory authority over any of the laws discussed in this article, so don’t just take our word for it.*

Expand Down
Loading