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
Alla Weinberg
People Are Sick of Change: Psychological Safety is the Cure (Videoconference)
2023 • DesignOps Community
Anna Avrekh
Expert Panel: Leading in and with Research
2022 • Advancing Research 2022
Gold
Charles Lee
Building a New Home for the Atlassian Design System (Videoconference)
2020 • Enterprise Community
Sarah Auslander
Insights Panel
2022 • Civic Design 2022
Gold
Roberta Dombrowski
Making Research a Team Sport
2022 • Advancing Research 2022
Gold
Louis Rosenfeld
Founder’s Welcome
2022 • Design in Product 2022
Gold
Kayla Farrell
What It's Like To Be a User Researcher at Compass
2021 • Advancing Research 2021
Gold
Sam Proulx
Understanding Screen Readers on Mobile: How And Why to Learn from Native Users
2023 • DesignOps Summit 2023
Gold
Emily Williams
When UX Research and Institutional Racism Collide: A Case Study
2021 • Advancing Research 2021
Gold
Bria Alexander
Charting the future of DesignOps: A community workshop (Videoconference)
2024 • DesignOps Community
Peter Van Dijck
Building the Rosenbot
2024 • Designing with AI 2024
Gold
Jackie Ho
Lead Effectively While Preserving Team Autonomy with Growth Boards
2024 • Enterprise Experience 2020
Gold
John Paul de Guzman
10k Screens Later: How We Became a Data-Driven Design Organization
2024 • DesignOps 2024
Gold
Dave Malouf
The Future of DesignOps
2024 • DesignOps Summit 2020
Gold
Trisha Terhar
Empathizing with the Empowered: Non-Researcher Responses to Democratization
2022 • Advancing Research 2022
Gold
Shipra Kayan
How Tess Dixon Facilitates Team Engagement and Collaboration at Condé Nast Using Miro 
2021 • DesignOps Summit 2021
Gold

More Videos

"We want teams to have autonomy and power to make pivot, shelve, and proceed decisions, not leadership dictating."

Standardizing Product Merits for Leaders, Designers, and Everyone

June 15, 2018

Simon Wardley

"Very few people in business are familiar with situational awareness unless they served in the military."

Simon Wardley

Maps and Topographical Intelligence (Videoconference)

January 31, 2019

Sandra Camacho

"White supremacy is the belief system of the superiority of whiteness that can embed itself in algorithms."

Sandra Camacho

Creating More Bias-Proof Designs

January 22, 2025

Darian Davis

"Taking responsibility starts with an apology and seeking regular feedback."

Darian Davis

Lessons from a Toxic Work Relationship

January 8, 2024

Fisayo Osilaja

"Providing more holistic recommendations helped us gain more trust and buy-in from stakeholders, increasing UX maturity."

Fisayo Osilaja

[Demo] The AI edge: From researcher to strategist

June 4, 2024

Uday Gajendar

"How do you create a sense of craft in an environment fraught with ambiguity, complexity, and anxiety?"

Uday Gajendar

The Wicked Craft of Enterprise UX

May 13, 2015

Davis Neable

"Consistency over business unit efficiency was a design principle to ensure unified interface and language."

Davis Neable Guy Segal

How to Drive a Design Project When you Don’t Have a Design Team

June 10, 2021

Eniola Oluwole

"People felt designs were self-evident and too much explanation was a barrier to using the patterns."

Eniola Oluwole

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

October 24, 2019

Aurobinda Pradhan

"We believe tracking design metrics aligned to business goals is important to demonstrate design’s impact."

Aurobinda Pradhan Shashank Deshpande

Introduction to Collaborative DesignOps using Cubyts

September 9, 2022