Rosenverse

This video is only accessible to Gold members. Log in or register for a free Gold Trial Account to watch.

Log in Register

Most conference talks are accessible to Gold members, while community videos are generally available to all logged-in members.

Documentation Your Team Will Actually Use
Gold
Tuesday, October 3, 2023 • DesignOps Summit 2023
Share the love for this talk
Documentation Your Team Will Actually Use
Speakers: Gabrielle Verderber
Link:

Summary

Picture this: You spend weeks writing up your UX Playbook. Your Playbook covers every design and research method your team might use, when to use it, and how. It’s PERFECT. And... no one reads it. I’ve been there! I’ve led or contributed to 4 Playbooks, 2 toolkits and uncountable miscellaneous “how to” docs in my 8 years as a UX Designer and Operations Manager. In this talk, we’ll cover how to: avoid common pitfalls in documentation, discover what your team needs most, apply a design process to your documentation efforts and deliver incremental value through documentation your team will actually use.

Key Insights

  • There are two main documentation types: process/policy docs created by managers or design ops, and project records created by individual contributors.

  • Playbooks organize information by work stages matching the organization's mental model, including detailed plays with instructions and templates.

  • Common pitfalls in playbooks include non-actionable info, poor navigation, cognitive overload, and outdated content.

  • Teams want documentation specific to their organization's processes, not generic explanations.

  • Navigation should align with users' mental models and include searchable content and cross-linking for discoverability.

  • Cognitive overload is reduced by using visual hierarchy, headers, lists, and removing unnecessary 'fluff'.

  • Regularly reviewing and updating documentation preserves trust and usability.

  • Applying a design thinking process—empathize, prioritize, prototype, test, circulate—improves documentation value and adoption.

  • Deliver small, complete documentation sections incrementally rather than waiting for a perfect complete playbook.

  • Shared ownership and collaboration on documentation fosters greater adoption and accuracy; design ops should avoid sole ownership.

Notable Quotes

"When we say documentation, I think of there being two main types: process and policy docs, and project records."

"Our folks are not looking for information about what are wireframes. They want information specific to your organization."

"If folks can't find the information, it doesn't matter how well it is written."

"Avoid walls of text and create visual hierarchy to ensure scanability by using headers, sections, lists and images."

"Imagine a team member goes to your playbook and the first link they click lands on a 404 page—this erodes trust."

"You don't want to dictate the process, especially if you're new to an organization."

"Your prototype is going to be imperfect. That's okay. Deliver small but complete sections to provide value sooner."

"I love getting other people in there. Shared ownership means people reference it more often and promote it."

"You should set a usage goal and track adoption metrics to learn why users may not be engaging with the documentation."

"A playbook is not a one hit wonder. You'll need someone to keep it up to date and revisit regularly."

Ask the Rosenbot
Ed Mullen
Designing the Unseen: Enabling Institutions to Build Public Trust
2022 • Civic Design 2022
Gold
Bria Alexander
Day 2 Welcome
2024 • DesignOps 2024
Gold
Miles Orkin
Creativity and Culture
2018 • DesignOps Summit 2018
Gold
Christopher Geison
Theme 1 Intro
2024 • Advancing Research 2024
Gold
Soma Ghosh
What emerging methods are advancing UX research [Advancing Research Community Workshop Series] (Videoconference)
2023 • Advancing Research Community
Meredith Black
Scaling Design Culture
2017 • DesignOps Summit 2017
Gold
Theresa Slate
Why Changing Hearts & Minds Doesn’t Work When Promoting DE&I Efforts, but Checklists Do
2023 • DesignOps Summit 2023
Gold
Brendan Jarvis
It was the Best of Times. It was the Worst of Times.
2024 • DesignOps 2024
Gold
Jilanna Wilson
Distributed DesignOps Management (Videoconference)
2019 • DesignOps Community
Charles Lee
Building a New Home for the Atlassian Design System (Videoconference)
2020 • Enterprise Community
Jemma Ahmed
Theme 2 Intro
2024 • Enterprise Experience 2020
Gold
Xenia Adjoubei
Empowering Communities Through the Researcher in Residence Program
2023 • Advancing Research 2023
Gold
Standardizing Product Merits for Leaders, Designers, and Everyone
2018 • Enterprise Experience 2018
Gold
Indra Klavins
A Design Ops Girl in a Dev Ops World
2019 • DesignOps Summit 2019
Gold
Sam Proulx
SUS: A System Unusable for Twenty Percent of the Population
2021 • Design at Scale 2021
Gold
Peter Merholz
Customer-Centered Design Organizations
2017 • Enterprise Experience 2017
Gold

More Videos

Jemma Ahmed

"Democratization is not research anarchy where anybody can talk to any customer for any reason with no oversight."

Jemma Ahmed Steve Carrod Chris Geison Dr. Shadi Janansefat Christopher Nash

Democratization: Working with it, not against it [Advancing Research Community Workshop Series]

July 24, 2024

Nina Jurcic

"The work of the design system is constant change management, raising awareness, and fostering common language."

Nina Jurcic

The Design System Rollercoaster: From Enabler and Bottleneck to Catalyst for Change

October 3, 2023

Nathan Curtis

"Can a designer make a pull request and have it reviewed? That open boundary between design and code is key to unlocking design system potential."

Nathan Curtis Nalini P. Kotamraju Jack Moffett Dawn Ressel

Discussion

June 9, 2016

Saara Kamppari-Miller

"When tactical metrics end up on the left side and KPIs on the right side of the compass, that signals we need a longer conversation about what we measure."

Saara Kamppari-Miller Nicole Bergstrom Shashi Jain

Key Metrics: Comparing Three Letter Acronym Metrics That Include the Word “Key”

November 13, 2024

Malini Rao

"The re-platforming journey is transformative not just for the product, but for the people and teams involved."

Malini Rao

Lessons Learned from a 4-year Product Re-platforming Journey

June 9, 2021

Mackenzie Cockram

"Over 4,000 users volunteered to look at the beta version, giving us excellent data at scale."

Mackenzie Cockram Sara Branco Cunha Ian Franklin

Integrating Qualitative and Quantitative Research from Discovery to Live

December 16, 2022

Bria Alexander

"If you signed up for a cohort, please make sure you’re in your private cohort channel to meet and discuss with your group."

Bria Alexander

Opening Remarks

June 9, 2021

Jackie Ho

"Many product teams have never come face to face with their revenue numbers before."

Jackie Ho

Lead Effectively While Preserving Team Autonomy with Growth Boards

January 8, 2024

Dan Hill

"When they become important is when they recede into the background and become mundane."

Dan Hill

Designing for the infrastructures of everyday life

June 4, 2024