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

Update meta data for UX Guide #516

Merged
merged 23 commits into from
Mar 29, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
23 commits
Select commit Hold shift + click to select a range
f34d556
Update meta data for values-and-principles.md
allisonpress Mar 28, 2024
b73c46e
Update meta data in index.md
allisonpress Mar 28, 2024
1893b39
Update meta data in LICENSE.md
allisonpress Mar 28, 2024
c990cd3
Update meta data in resources.md
allisonpress Mar 28, 2024
28df1ce
Update meta data in index.md
allisonpress Mar 28, 2024
403b633
Update meta data in defining-design.md
allisonpress Mar 28, 2024
5d357dc
Update meta data in stay-lean.md
allisonpress Mar 28, 2024
fb2f95e
Update meta data in meet-people-where-they-are.md
allisonpress Mar 28, 2024
ee9930b
Update meta data in index.md
allisonpress Mar 28, 2024
b49c2ad
Update meta data in clarify-the-basics.md
allisonpress Mar 28, 2024
1a4914d
Update meta data in plan.md
allisonpress Mar 28, 2024
9c7a7e7
Update meta data in do.md
allisonpress Mar 28, 2024
2e845ba
Update meta data in make-research-actionable.md
allisonpress Mar 28, 2024
84b712c
Update meta data in legal.md
allisonpress Mar 28, 2024
5362fa3
Update meta data in privacy.md
allisonpress Mar 28, 2024
6baf1b2
Update meta data in bias.md
allisonpress Mar 28, 2024
66425e5
Update meta data in ethics.md
allisonpress Mar 28, 2024
381eb4c
Update meta data in share-power.md
allisonpress Mar 28, 2024
6a3c5f9
Update meta data in index.md
allisonpress Mar 28, 2024
8fc955c
Update meta data in build-a-prototype.md
allisonpress Mar 28, 2024
23dd5c2
Update meta data in use-a-design-system.md
allisonpress Mar 28, 2024
f3a1c94
Ignore iframes to fix intermittent pa11y errors
neilmb Mar 29, 2024
6eee6be
Fix pa11y configuration
neilmb Mar 29, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 0 additions & 8 deletions .pa11yci

This file was deleted.

10 changes: 10 additions & 0 deletions .pa11yci.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
module.exports = {
defaults: {
concurrency: 1,
standard: "WCAG2AA",
runners: ["htmlcs"],
// ignore iframes because we don't use them and DAP inserts an iframe
// that causes intermittent pa11y errors
hideElements: "iframe, div[style*='display: none;'], [data-pa11y-ignore], a[href*='/TODO/"
}
}
1 change: 1 addition & 0 deletions content/ux-guide/LICENSE.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: License
description: "18F's User Experience Guide is in the public domain, and waives copyright and related rights."
permalink: /ux-guide/license/
layout: layouts/page
tags: ux-guide
Expand Down
2 changes: 1 addition & 1 deletion content/ux-guide/design/build-a-prototype.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Build a prototype
description: "18F encourages building something that will help you answer your questions with the least investment."
description: "How to build a prototype, from a paper sketch to a static site in Cloud.gov Pages, and things to consider when designing one."
permalink: /ux-guide/design/build-a-prototype/
layout: layouts/page
tags: ux-guide
Expand Down
2 changes: 1 addition & 1 deletion content/ux-guide/design/index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Design
description: "About prototypes and how they inform the work of 18F, as well as resources on web publishing platforms and design systems to help you get started."
description: "How 18F creates prototypes and uses them for communication."
permalink: /ux-guide/design/
layout: layouts/page
tags: ux-guide
Expand Down
2 changes: 1 addition & 1 deletion content/ux-guide/design/use-a-design-system.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Use a design system
description: "A design system can help your team prototype faster, scale, manage front-end design debt, and apply consistency across your applications."
description: "On the benefits of using a design system, with a brief introduction to the U.S. Web Design System."
permalink: /ux-guide/design/use-a-design-system/
layout: layouts/page
tags: ux-guide
Expand Down
2 changes: 1 addition & 1 deletion content/ux-guide/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ subnav:
href: "#reusing-this-guide-in-other-organizations"
- text: References
href: "#references"
description: "How 18F user experience (UX) designers improve interactions between our government and the public"
description: "How user experience (UX) designers at 18F approach their work, from conducting research to building prototypes."
---
18F user experience (UX) designers join cross-functional teams to improve interactions between government agencies and the people they serve. The 18F UX Guide helps us get this job done. It’s a starting point for UX design at 18F: doing it, discussing it, and ensuring it’s done to a consistent level of quality.

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
@@ -1,6 +1,6 @@
---
title: Defining design
description: "18F user experience (UX) designers see design as a process of intentionally deciding, over and over, how interactions should work for users, based on research."
description: "18F defines design as a process of deciding, over and over, how interactions and systems should work for people, based on research."
permalink: /ux-guide/our-approach/defining-design/
layout: layouts/page
tags: ux-guide
Expand Down
2 changes: 1 addition & 1 deletion content/ux-guide/our-approach/index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Our approach
description: "Read about 18F's essential approach to our design practice."
description: "An introduction to 18F's UX design practice, including team values, definitions of design, and staying lean."
permalink: /ux-guide/our-approach/
layout: layouts/page
tags: ux-guide
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Meet partners where they are
description: "18F user experience (UX) designers view government agency partners as co-creators, encouraging a more participatory and sustainable design process."
description: "18F's approach to bringing partners into the design process as co-creators."
permalink: /ux-guide/our-approach/meet-partners-where-they-are/
layout: layouts/page
tags: ux-guide
Expand Down
2 changes: 1 addition & 1 deletion content/ux-guide/our-approach/stay-lean.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Stay lean
description: "18F user experience (UX) designers take a collaborative, incremental, and outcome-focused approach to our work."
description: "The Lean UX process involves research in each phase of a project to support continuous learning."
permalink: /ux-guide/our-approach/stay-lean/
layout: layouts/page
tags: ux-guide
Expand Down
2 changes: 1 addition & 1 deletion content/ux-guide/our-approach/values-and-principles.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Values and principles
description: "These are the fundamentals that guide our work as 18F user experience (UX) designers."
description: "Values and principles that guide 18F's UX design process, including collaboration, working iteratively, and learning from real people about their diverse needs."
permalink: /ux-guide/our-approach/values-and-principles/
layout: layouts/page
tags: ux-guide
Expand Down
2 changes: 1 addition & 1 deletion content/ux-guide/research/bias.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Bias
description: "These are 18F's starting points for proactively engaging with bias in the user research process."
description: "Definitions of different types of bias and explanation of how 18F accounts for bias in research."
permalink: /ux-guide/research/bias/
layout: layouts/page
tags: ux-guide
Expand Down
2 changes: 1 addition & 1 deletion content/ux-guide/research/clarify-the-basics.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Clarify the basics
description: "All 18F teams commit to continuous design research in order to make better decisions informed by end user perspectives."
description: "The basics of conducting UX research, including making research collaborative, explanations of methods, and best practices."
permalink: /ux-guide/research/clarify-the-basics/
layout: layouts/page
tags: ux-guide
Expand Down
2 changes: 1 addition & 1 deletion content/ux-guide/research/do.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Do
description: "After planning, doing research involves engaging with previously agreed upon knowledge, participants, and data."
description: "How to conduct UX research, from designing, rehearsing, and moderating research sessions to debriefing as a team."
permalink: /ux-guide/research/do/
layout: layouts/page
tags: ux-guide
Expand Down
2 changes: 1 addition & 1 deletion content/ux-guide/research/ethics.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Ethics
description: "The following ethical principles help guide 18F user experience (UX) designers through some of the choices that this work can present."
description: "Ethical considerations for UX research and design, and how to acknowledge your power and privilege as a designer."
permalink: /ux-guide/research/ethics/
layout: layouts/page
tags: ux-guide
Expand Down
2 changes: 1 addition & 1 deletion content/ux-guide/research/index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Research
description: "Design research explores possibilities, tests assumptions, and reduces risk by actively and systematically engaging with the world."
description: "How to conduct ethical, inclusive, and unbiased research with people while protecting their Personally Identifiable Information (PII)."
permalink: /ux-guide/research/
layout: layouts/page
tags: ux-guide
Expand Down
2 changes: 1 addition & 1 deletion content/ux-guide/research/legal.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Legal
description: "18F designs our research to account for The Antideficiency Act and The Paperwork Reduction Act of 1995 (PRA), among other laws."
description: "How 18F conducts qualitative research that complies with the Paperwork Reduction Act of 1995 (PRA)."
permalink: /ux-guide/research/legal/
layout: layouts/page
tags: ux-guide
Expand Down
2 changes: 1 addition & 1 deletion content/ux-guide/research/make-research-actionable.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Make research actionable
description: "Analysis, synthesis, and sharing helps 18F user experience (UX) designers reflect on the data we’ve collected and determine a course of action."
description: "How to make UX research actionable, such as how to turn data into insights and share those with others."
permalink: /ux-guide/research/make-research-actionable/
layout: layouts/page
tags: ux-guide
Expand Down
2 changes: 1 addition & 1 deletion content/ux-guide/research/plan.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Plan
description: "Planning helps 18F teams adapt our approaches to the real world and ensures everyone's time is respected throughout the research process."
description: "How to plan UX research, including writing a plan, recruiting participants, defining outcomes, involving partners, and documentation."
permalink: /ux-guide/research/plan/
layout: layouts/page
tags: ux-guide
Expand Down
2 changes: 1 addition & 1 deletion content/ux-guide/research/privacy.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Privacy
description: "18F’s research practices are grounded in building and maintaining trust with research participants, a large part of which is protecting their privacy."
description: "How 18F protects the Personally Identifiable Information (PII) of research participants, including collecting consent and storing participant information."
permalink: /ux-guide/research/privacy/
layout: layouts/page
tags: ux-guide
Expand Down
2 changes: 1 addition & 1 deletion content/ux-guide/research/share-power.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Power dynamics in research
description: "Power is the ability to influence a situation. It is relative to where you fit within a situation, culture, or system. Power is not good or bad, it's how it is used or distributed that determines its value."
description: "An overview of power dynamics in research, examples of formal and informal types of power, and methods for sharing and shifting power."
permalink: /ux-guide/research/share-power/
layout: layouts/page
tags: ux-guide
Expand Down
2 changes: 1 addition & 1 deletion content/ux-guide/resources.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Resources
description: "Additional templates, checklists, presentations, and other resources that 18F user experience (UX) designers use."
description: "Templates, presentations, and checklists to use in a UX research and design process."
permalink: /ux-guide/resources/
layout: layouts/page
tags: ux-guide
Expand Down
Loading