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

Clemens Janssen
Efficiently Scaling Research as a Team of One
2023 • Advancing Research 2023
Gold
Bud Caddell
Theme 2 Intro
2021 • DesignOps Summit 2021
Gold
Sam Proulx
Online Shopping: Designing an Accessible Experience
2023 • Design in Product 2023
Gold
Fisayo Osilaja
[Demo] The AI edge: From researcher to strategist
2024 • Designing with AI 2024
Gold
Stefanie Owens
Optimizing for Outcomes: Transformation Design in Systems at Scale
2024 • Advancing Service Design 2024
Gold
Lais de Almeida
Designing Data Services
2024 • Advancing Service Design 2024
Gold
Yalenka Mariën
Designing for Digital Inclusion in the Belgian Government
2021 • Civic Design 2021
Gold
Lija Hogan
Three Years Out: Perspectives on the Near-Term Future of User Research
2024 • Advancing Research Community
Jen Cardello
Learning Velocity—The Insights Speedometer
2021 • Advancing Research Community
Alexia Cohen
Increasing Health Equity and Improving the Service Experience for Under-Served Latine Communities in Arizona
2024 • Advancing Service Design 2024
Gold
Aaron Stienstra
Leveraging Civic Design to Advance Equity and Rebuild Trust in the US Federal Government
2021 • Civic Design 2021
Gold
Mariah Hay
Ethics in Tech Education: Designing to Provide Opportunity for All
2018 • Enterprise Experience 2018
Gold
Christian Rohrer
Research Operations at Scale
2017 • DesignOps Summit 2017
Gold
Sheryl Cababa
Thinking in systems to address climate with Sheryl Cababa
2024 • Climate UX Interest Group
Dave Hoffer
UX Job Search AMA #2 with Joanne Weaver and Dave Hoffer
2025 • Rosenfeld Community
Meghan Hellstern
The Next 100 Years of Civic Design: How Might We Better Rise to Meet the Challenges of Today and Tomorrow?
2021 • Civic Design 2021
Gold

More Videos