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."

Jilanna Wilson
Distributed DesignOps Management (Videoconference)
2019 • DesignOps Community
Sam Yen
Driving Organizational Change Through Design? Do more of this and less of that
2017 • Enterprise Experience 2017
Gold
Suzan Bednarz
AccessibilityOps for All
2024 • DesignOps Summit 2020
Gold
Marisa Bernstein
It Takes GRIT: Lessons from the Small, but Mighty World of Civic Usability Testing
2021 • Civic Design 2021
Gold
Mark Interrante
Collaboration Flows in Product Development
2017 • Enterprise Experience 2017
Gold
Sean Fitzell
Craft of User Research: Building Out Jobs to be Done Maps
2021 • Advancing Research 2021
Gold
Jon Fukuda
Theme One Intro
2023 • DesignOps Summit 2023
Gold
Jackie Velasquez-Ross
Talent Acquisition and Our Responsibility (Videoconference)
2020 • DesignOps Community
Bill Scott
Lean Engineering: Engineering for Learning and Experimentation in the Enterprise
2015 • Enterprise UX 2015
Gold
Hugh Dubberly
Problems with Problems: Reconsidering the Frame of Designing as Problem-Solving (Videoconference)
2019 • Enterprise Community
Sam Proulx
Prototype Reviews, People With Disabilities, and You
2021 • Civic Design 2021
Gold
Michael Weir
Mixed Methods and Behavioural Science (Videoconference)
2023 • Rosenfeld Community
Megan Clegg
Space for Everyone: Reframing Accessibility Through a Wider Lens
2021 • Design at Scale 2021
Gold
Scher Foord
Turn the Ship Around: How to Apply Design Thinking Across Your Organization
2021 • Design at Scale 2021
Gold
Christopher Noessel
AI of the now: Designing for Agents
2024 • Rosenfeld Community
Uday Gajendar
The Rise of Meta-Design: A Starter Playbook (Videoconference)
2022 • Enterprise Community

More Videos

Monty Hammontree

"UX research needed to be a team sport involving all disciplines rather than the few learning on behalf of the many."

Monty Hammontree

The Future of UX Research (Videoconference)

December 3, 2020

Liz Ebengo

"We always begin our research from the future to the future: start with the community’s envisioned future to guide design."

Liz Ebengo

The Burden on Children: The Cost of Insufficient Post-Conflict Services and Pathways Forward

December 4, 2024

Billy Carlson

"Tell a story with your design by starting with background, introducing the users, and demonstrating how the design benefits them."

Billy Carlson

Tips to Utilize Wireframes to Tell an Effective Product Story

June 6, 2023

Saara Kamppari-Miller

"Traditional UX tools like sticky notes are not accessible to everyone, including blind users or those with invisible disabilities."

Saara Kamppari-Miller

Inclusive Design is DesignOps

September 29, 2021

Ian Swinson

"Leadership does not mean standing in front of a room. It means mentoring, influencing, and helping others grow."

Ian Swinson

Designing and Driving UX Careers

June 8, 2016

Jonathon Colman

"People assumed Facebook was always listening to their conversations because we didn’t clearly explain how and why the feature worked."

Jonathon Colman

How to Maximize the Impact of Content Design

January 8, 2024

Maria Skaaden

"Opening the feedback board to the whole team made developers feel responsible and inspired to solve user needs."

Maria Skaaden

Continuous Design: One eye on the horizon and the other on the next wave

November 8, 2018

Bryce Benton

"You can tune AI writing so it's not just compliance, but really using principles for the right reasons because they're actually helpful."

Bryce Benton

[Demo] AI-powered UX enhancement: Aligning GitHub documentation with USWDS at Austin Public Library

June 4, 2024

Marc Fonteijn

"The satisfaction score is going down even though average salary is going up — that’s something interesting we should dig into."

Marc Fonteijn

First Insights from the 2025 Service Design Salary(+) Report

December 4, 2024