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
Maish Nichani
Sparking a Service Excellence Mindset at a Government Agency
2021 • Civic Design 2021
Gold
Bria Alexander
Opening Remarks
2023 • Advancing Research 2023
Gold
Shan Shen
Translating UX Terms into Business Contexts
2023 • Design in Product 2023
Gold
Dan Willis
Filling the Void
2018 • DesignOps Summit 2018
Gold
Sarah Sgarlato Pierini
From Passion to Execution: A Story of Evolving Research Maturity at LinkedIn
2022 • DesignOps Summit 2022
Gold
Briana Thomas
The Quiet Force: Uncovering Hidden Leadership in High-Impact Design Teams
2024 • DesignOps 2024
Gold
Chris Geison
What's Next for Research? (Videoconference)
2021 • Advancing Research Community
Wendy Johansson
Be a Product Boss!
2022 • Design in Product 2022
Gold
Sheryl Cababa
Day 2 Panel
2024 • Designing with AI 2024
Gold
Ivana Ng
Level Up Your Program with ProductOps
2024 • Enterprise Experience 2020
Gold
Kim Lenox
Leading Distributed Global Teams (Videoconference)
2019 • Enterprise Community
Victor Udoewa
Radical Participatory Research: Decolonizing Participatory Processes
2022 • Advancing Research 2022
Gold
Zariah Cameron
Streamlining an Inclusive Design Practice
2023 • DesignOps Summit 2023
Gold
Bria Alexander
Theme 1 Intro
2024 • DesignOps 2024
Gold
Husani Oakley
Theme Three Intro
2023 • Enterprise UX 2023
Gold
Dan Hill
Strategic design, slowdown, and the infrastructures of everyday life (Videoconference)
2022 • Enterprise Community

More Videos

Zariah Cameron

"Share everything, own nothing but credit everyone."

Zariah Cameron

ReDesigning Wellbeing for Equitable Care in the Workplace

September 23, 2024

John Cutler

"The top priority is often the lack of a priority, resulting in teams spending 50% of their time jumping between priorities."

John Cutler Harry Max

Prioritization for designers and product managers (1st of 3 seminars) (Videoconference)

June 13, 2024

Nick Cochran

"Working in enterprise can feel like chaos with unclear directions and too much noise from new initiatives every six months."

Nick Cochran

Growing in Enterprise Design through Making Connections

June 3, 2019

Deanna Smith

"Not everything that is faced can be changed, but nothing can be changed until it is faced. - James Baldwin"

Deanna Smith

Leading Change with Confidence: Strategies for Optimizing Your Process

September 23, 2024

Magdalena Zadara

"We started the Digital Service as a subsidiary company of the government, not just a government unit."

Magdalena Zadara

Zero Hour: How to Get Far Quickly When Starting Your Digital Service Unit Late

November 16, 2022

Nova Wehman-Brown

"We made it easier for him to say yes by making it easier to say no."

Nova Wehman-Brown

We've Never Done This Before

June 4, 2019

Liwei Dai

"Machines may identify that higher ice cream sales is associated with higher band ice, but the former is not causing the latter."

Liwei Dai

The Heart and Brain of the AI Research

March 31, 2020

Gordon Ross

"My phone buzzed again. I have a job this weekend for you and your team to help on the COVID response if you’re available."

Gordon Ross

12 Months of COVID-19 Design and Digital Response with the British Columbia Government

December 8, 2021

Tutti Taygerly

"Listening to the 10% truth means acknowledging a bit of what they say even if you’re irritated."

Tutti Taygerly

Make Space to Lead

June 12, 2021