If a genie jumped out of my coffee right now and offered to grant me a wish, here’s what I’d want (world peace is overrated):
I want a way to put a sunset date onto technical web data, so that I can find relevant technical information instead of the one “Introduction to Tomcat” that 5 gzillion people downloaded 6 years ago, and that eventually reveals itself to be 3 versions out of date, but still shows up at the top of the hit list.
I would love to have a way to know that when presented with two webpages, each describing two COMPLETELY different ways to do something without mentioning a date or a version or a platform, I can pick the one that isn’t going to waste 6 hours of my time.
Scope. Context. That is what I wish for. A consistent way to determine scope and context.
This is my own reminder to myself, to write documentation that includes scope and context, right up front. Whatever I can go back and add scope to, I will. I will imagine that it is 10 years from now, and .NET Framework 27.2 has just been released, and I want to put that on my machine along with Higgins Framework 10.7b. Either my documents should be still-relevant, or instantly dismissable. If I can accomplish that, and keep it up, I’ll be happy.
The worst documentation is the vendor-branded stuff, of course. No author. No date. No version. Erg.