After releasing documentation for a calendar application, we received so many questions and frustrated feedback from users that I started thinking about publishing a page in the help describing what the calendar doesn't do. I'm in an agile shop, so the calendar is still undergoing development, and many of the features people want are eventually coming; other features are problematic due to bugs; other features are frustrating by design. :)
I was trained to spin documentation in a positive light, so I'm accustomed to explaining what you can do with the product. You can do this, and that, and look how wonderful this thing is! You can do this, and if you want, you can do that...
Well, for every "can," there's a "can't." And it's not always clear to users whether a task they want to do falls in the can or can't bucket. Maybe you can do something with the app -- you just haven't figured out how. Maybe it is possible, if you know which menu to click, or how to access a certain dialog box, or a deeply buried menu option. Or maybe, after trying for hours and not finding it in the help, you're forced to conclude that you simply can't do it.
After expressing a need for negative documentation, Paul Scholar told me the term is "Known Limitations." I like the sound of it.
My Known Limitations page is here. It's not too long, because the length alone would send the wrong message. Also, the list doesn't cover every bug, since many bugs are still invisible to users and listing them all, or a lot more of them, would lower confidence in the app.
I initially included some limitations by design. For example, the calendar doesn't have a Day view, but I later took these out, since all the other known limitations would be fixed in a later release. So these other "crappy features by design" didn't fit.
I like this known limitations idea. When I get frustrated with an app, I want to consult the negative space of the help content. Is what I'm trying to do even possible? Rather than skimming and scanning through hundreds of topics, looking for a little note or caveat, just tell me up front the shortcomings of the product. This will save me time, and your honesty will increase my respect for you.
Get new posts delivered straight to your inbox.
I'm a technical writer based in the California San Francisco Bay area. Topics I write about on this blog include technical writing, authoring and publishing tools, API documentation, tech comm trends, visual communication, technical writing career advice, information architecture and findability, developer documentation, and more. If you're a professional or aspiring technical writer, be sure to subscribe to email updates using the form above. You can learn more about me here. You can also contact me with questions.