Merge pull request #516 from 18F/allisonpress-uxguide-metadata

Update meta data for UX Guide
18F · Mar 29, 2024 · 9120c42 · 9120c42
2 parents 4e03b8b + 6eee6be
commit 9120c42
Show file tree

Hide file tree

Showing 23 changed files with 31 additions and 28 deletions.
diff --git a/.pa11yci b/.pa11yci
diff --git a/.pa11yci.js b/.pa11yci.js
@@ -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/"
+  }
+}
diff --git a/content/ux-guide/LICENSE.md b/content/ux-guide/LICENSE.md
@@ -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

diff --git a/content/ux-guide/design/build-a-prototype.md b/content/ux-guide/design/build-a-prototype.md
@@ -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

diff --git a/content/ux-guide/design/index.md b/content/ux-guide/design/index.md
@@ -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

diff --git a/content/ux-guide/design/use-a-design-system.md b/content/ux-guide/design/use-a-design-system.md
@@ -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

diff --git a/content/ux-guide/index.md b/content/ux-guide/index.md
@@ -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.
 

diff --git a/content/ux-guide/our-approach/defining-design.md b/content/ux-guide/our-approach/defining-design.md
@@ -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

diff --git a/content/ux-guide/our-approach/index.md b/content/ux-guide/our-approach/index.md
@@ -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

diff --git a/content/ux-guide/our-approach/meet-people-where-they-are.md b/content/ux-guide/our-approach/meet-people-where-they-are.md
@@ -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

diff --git a/content/ux-guide/our-approach/stay-lean.md b/content/ux-guide/our-approach/stay-lean.md
@@ -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

diff --git a/content/ux-guide/our-approach/values-and-principles.md b/content/ux-guide/our-approach/values-and-principles.md
@@ -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

diff --git a/content/ux-guide/research/bias.md b/content/ux-guide/research/bias.md
@@ -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

diff --git a/content/ux-guide/research/clarify-the-basics.md b/content/ux-guide/research/clarify-the-basics.md
@@ -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

diff --git a/content/ux-guide/research/do.md b/content/ux-guide/research/do.md
@@ -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

diff --git a/content/ux-guide/research/ethics.md b/content/ux-guide/research/ethics.md
@@ -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

diff --git a/content/ux-guide/research/index.md b/content/ux-guide/research/index.md
@@ -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

diff --git a/content/ux-guide/research/legal.md b/content/ux-guide/research/legal.md
@@ -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

diff --git a/content/ux-guide/research/make-research-actionable.md b/content/ux-guide/research/make-research-actionable.md
@@ -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

diff --git a/content/ux-guide/research/plan.md b/content/ux-guide/research/plan.md
@@ -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

diff --git a/content/ux-guide/research/privacy.md b/content/ux-guide/research/privacy.md
@@ -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

diff --git a/content/ux-guide/research/share-power.md b/content/ux-guide/research/share-power.md
@@ -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

diff --git a/content/ux-guide/resources.md b/content/ux-guide/resources.md
@@ -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