Schrödinger's Documentation
Schrödinger's Documentation: A Quantum Dilemma
I found this quote "Schrödinger's documentation: If there are docs, no one will read them. If there are no docs, everyone will complain." (Marit van Dijk) on one of the reading newsletters I subscribe to. I posted it on LinkedIn and it turned out to be my most popular post on social media ever.
When I came across this quote in one of the newsletters I subscribe to, I chuckled, nodded, and shared it on LinkedIn without much thought. To my surprise, it became my most popular post on social media ever. Clearly, I wasn’t alone in finding the humor—and the truth—in this paradoxical statement.
As a technical writer, this idea of "Schrödinger's documentation" resonates deeply. I live the paradox daily, navigating the fine line between creating documentation thorough enough to answer any question, yet concise enough that people might actually read it. But it doesn’t end there; I feel the same frustration as a user. Whether it’s troubleshooting a stubborn piece of software or assembling a flat-pack piece of furniture, I’ve been on the other side of the documentation divide, longing for clear, helpful guidance… Or wondering why the instructions seem to be in a foreign language.
A Quantum Problem for Writers and Readers
This paradox feels almost quantum in nature. On the one hand, as a writer, I wrestle with the challenge of creating documentation that is easy to find, easy to follow, and easy to maintain. On the other hand, as a reader, I understand the tendency to skim or outright ignore the documentation unless I’m absolutely stuck. It’s as if the documentation exists in a superposition of being both necessary and neglected until the moment it’s observed (or needed).
The problem is universal, yet deeply personal. As writers, we pour our energy into crafting documentation that anticipates every user’s needs, knowing full well that many will never read it. As users, we overlook the documentation, confident that we can figure things out on our own…until we can’t. In that moment, our frustration mounts, and we find ourselves cursing at the lack of documentation or its perceived inadequacy.
Why Does This Paradox Exist?
The Schrödinger’s documentation problem arises from several factors:
- Time pressures: users are often in a rush to solve their problems, skipping documentation in favor of trial and error.
- Poor discoverability: even the best documentation is useless if readers can’t find it quickly.
- Overwhelming information: documentation that is too dense or overly technical can discourage users from engaging with it.
- Cognitive biases: people often assume they can figure things out independently, only turning to documentation as a last resort.
How can we, as writers and readers, address this paradox?
Writers
- Focus on clarity: write documentation that is concise, well-structured, and easy to navigate.
- Improve discoverability: use search-friendly terms and integrate documentation directly into user workflows.
- Incorporate feedback: regularly gather input from users to understand their pain points and adapt documentation accordingly.
Readers
- Give documentation a chance: Before diving into troubleshooting, take a moment to review the available documentation.
- Provide Feedback: if documentation is unclear or unhelpful, let the writers know. Constructive criticism helps improve future iterations.
Embracing the Paradox
While Schrödinger’s documentation might feel like an unsolvable problem, it’s also a reminder of the human element in technical communication. Writers strive to anticipate user needs, and readers navigate their own learning curves and frustrations. By acknowledging both perspectives—and fostering collaboration between them—we can create documentation that, while it may never be perfect, better serves everyone.
The next time you encounter a piece of documentation, remember the paradox. Whether you’re writing it or reading it, you’re part of the quantum dance that brings information to life.