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

  • Documentation should focus on actionable and clear instructions rather than generic content.

  • Easy navigation is crucial; if people can't find the information, it becomes useless.

  • Cognitive overload can be minimized by breaking down information into digestible parts and using visual hierarchy.

  • Regularly updating content is necessary to maintain trust and usability of the playbook.

  • Empathizing with team members helps identify their actual needs and biggest frustrations with existing documentation.

  • Incremental delivery of documentation ensures teams can provide feedback early, improving the final product.

  • Utilizing design thinking principles can enhance the documentation creation process.

  • Involving team members in content ownership fosters collaboration and increases documentation utilization.

  • Tracking adoption metrics and understanding content usage is essential for refining documentation.

  • Documentation should be continuously iterated upon as processes and tools evolve.

Notable Quotes

"Documentation must be actionable and reflect your organization's practices, not just generic information."

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

"You need to understand how people are working and what they need help with."

"Leave out generic content and focus on what your team needs."

"Imagine if team members find broken links in your playbook – it erodes trust."

"Empathize with your team to ensure the documentation meets their needs."

"Don't hide away for six months trying to build the perfect documentation."

"Deliver small complete sections to get feedback sooner rather than waiting for a finished product."

"A playbook is not a one-hit wonder; it needs ongoing maintenance and updates."

"Encourage team adoption by sharing documentation widely and pinning it in accessible channels."

Gordon Ross
12 Months of COVID-19 Design and Digital Response with the British Columbia Government
2021 • Civic Design 2021
Gold
Ross Smith
Breaking Barriers with Empathy
2017 • Enterprise Experience 2017
Gold
Leah Buley
Closing Plenary: The Crisis of Digital
2020 • Advancing Research 2020
Gold
Alexia Cohen
Increasing Health Equity and Improving the Service Experience for Under-Served Latine Communities in Arizona
2024 • Advancing Service Design 2024
Gold
Sahibzada Mayed
The Politics of Radical Research: A Manifesto
2023 • Advancing Research 2023
Gold
Lily Aduana
5 Reasons to Bring Your Recruiting in-House (and How To Do It)
2021 • Advancing Research 2021
Gold
Craig Villamor
Design Systems for Ethical Design
2023 • Enterprise Community
Rebecca Buck
Mission: Keep Talent in Research Roles!
2021 • Advancing Research 2021
Gold
Bill Scott
Lean Engineering: Engineering for Learning and Experimentation in the Enterprise
2015 • Enterprise UX 2015
Gold
Bryce Benton
[Demo] AI-powered UX enhancement: Aligning GitHub documentation with USWDS at Austin Public Library
2024 • Designing with AI 2024
Gold
Holly Cole
Panel Discussion: Growing People and Teams
2018 • DesignOps Summit 2018
Gold
Erin Weigel
Real-world lessons to improve your conversion rates
2024 • Rosenfeld Community
Landon Barnes
Are My Research Findings Actually Meaningful?
2022 • Advancing Research 2022
Gold
Jemma Ahmed
Redefining the research toolkit: Expanding methodologies for a changing world
2025 • Advancing Research 2025
Gold
Ron Bronson
Design, Consequences & Everyday Life
2022 • Civic Design 2022
Gold
Julie Gitlin
Design as an Agent of Digital Transformation at JPMC
2021 • Design at Scale 2021
Gold

More Videos

"It's impossible to dispute a pin you get from customers."

Discussion

June 9, 2017

Bria Alexander

"Resilience means the capacity to withstand or recover quickly from difficulties."

Bria Alexander

Theme 1 Intro

September 23, 2024

Benjamin Wiedmaier

"Adaptability really helps teams win in a dynamic work environment."

Benjamin Wiedmaier Annie Mayfield

Redefining Toolkits: Unbundling to Create a Perfect Match

March 11, 2025

Eniola Oluwole

"We wanted everyone to access patterns easily, but we also needed accountability for those patterns."

Eniola Oluwole

Lessons From the DesignOps Journey of the World's Largest Travel Site

October 24, 2019

Justin Entzminger

"Engaging with historically black colleges and universities can enhance our pool of diverse applicants."

Justin Entzminger Terrance Smith Tracy M. Colunga Mai-Ling Garcia

Risk and Reward: How to Diversify the Field of Civic Innovators and Designers

November 17, 2022

Bria Alexander

"Welcome to day three of Design Ops Summit 2023."

Bria Alexander

Opening Remarks

October 4, 2023

Holly Cole

"I want you to take a little time out of your week and say, hey, what is it like working for me?"

Holly Cole

Understanding Experiences: When you have to do more than work

November 8, 2018

Mohammad Hossein Jarrahi

"There's no perfect truth; what matters is the practical usefulness of research outcomes."

Mohammad Hossein Jarrahi

Contextuality problem: Exploring the Benefits of Qualitative and Quantitative Research

January 20, 2023

Brad Peters

"During roadmapping time, let’s talk to each other and discover those synergies."

Brad Peters Anne Mamaghani

Short Take #1: UX/Product Lessons from Your Industry Peers

December 6, 2022