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

More Videos

John Maeda

"Leadership is best when people barely know she exists."

John Maeda

Making Sense of Enterprise UX

June 9, 2016

Indi Young

"These thinking styles allow us to start filling in gaps for people who feel unsupported."

Indi Young

Thinking styles: Mend hidden cracks in your market

January 8, 2025

Chris Chapo

"What if design teams and data teams could partner up to solve big customer problems?"

Chris Chapo

Data Science and Design: A Tale of Two Tribes

May 13, 2015

Elizabeth Churchill

"We observed how cultural practices impact technology uptake."

Elizabeth Churchill

Exploring Cadence: You, Your Team, and Your Enterprise

June 8, 2017

Rusha Sopariwala

"There was no choice but to adapt."

Rusha Sopariwala

Remote, Together: Craft and Collaboration Across Disciplines, Borders, Time Zones, and a Design Org of 170+

June 9, 2022

George Aye

"What if we could have a system of accountability that includes a code of ethics?"

George Aye

That Quiet Little Voice: When Design and Ethics Collide

November 16, 2022

Ariba Jahan

"Resilience is about maintaining self needs and effectiveness at moments of change, tough demands, and adversity."

Ariba Jahan

Team Resiliency Through a Pandemic

January 8, 2024

Julie Gitlin

"Executive sponsorship is essential for scaling design thinking across the organization."

Julie Gitlin Esther Raice

Design as an Agent of Digital Transformation at JPMC

June 9, 2021

Matteo Gratton

"It’s important to be transparent so everyone knows what they can see about what they did."

Matteo Gratton

Can Data and Ethics Live Together?

October 1, 2021