1. Original Entry + Comments2. Write a Comment3. Preview Comment


August 12, 2008  |  More on MSDN  |  1105 hit(s)

In the wake of my recent yackery about undocumentation on MSDN, Seth drew my attention to some comments on a mini-microsoft blog post. As usual, the comment threads, which are huge, veer far, far off topic. Interspersed among all the other sniping, the comment thread in question addresses the usefulness of documentation on MSDN.

This is the initial complaint:
... the MSDN documentation continues to be so thunderingly useless. A 10-second Google search almost always finds blogs or articles far superior to the cruft in MSDN.
Another commenter joins the fray:
MSDN is the sole reason why Open Source hasn't yet completely taken over as a development platform. They don't have proper documentation for stuff and we do, so when you develop something you KNOW you'll be able to figure things out quickly, either from MSDN or from people who have read MSDN and created their own samples (where else do you think they got their knowledge from?).

I could name quite a few things Microsoft puts out that are "useless", but MSDN is not among them.
There is some back-and-forth about MSDN, which mostly gets into the search capabilities of MSDN. Returning to content, someone who is probably a writer in the Developer Division observes:
... when a single writer is responsible for maintaining 3500 pages of documentation, content will usually suck to one degree or another. Pick about 10 tech books on your shelf. That's the amount of text some writers are responsible for keeping up to date.

They'd love to write samples or dig into obscure failure modes of APIs, but just don't have the time.
This is answered by the now-familiar request to make documentation into a wiki:
Which is why the MSDN folks need to transform the documentation into a moderated Wiki initially open to MVPs, UA, product groups and other credible folks.

How else to get meaningful how-to, scenario, code snippet, and in-the-trenches content on a regular basis?
To the extent that there is encouraging news here, it's that the complaints focus primarily on search (in this thread, anyway). You can see that the thesis of my earlier post is seconded by the presumptive writer who indicates the scope of coverage required to maintain the current doc set.

The wiki idea is, as noted, familiar. In fact, MSDN allows users to amend (tho not change) content. I hope that advocates of wikifying MSDN are taking full advantage of this feature, which has been available for ... lessee ... getting on two years now. See you there!




Dylan   12 Aug 08 - 10:58 AM

(I should probably preface this post by saying I do a lot of SharePoint development right now, so my experience may be different.)

I actually like MSDN's documentation on most things. Granted, I usually get there by typing in a class or method name through Google, but it's usually pretty complete. Its big weakness is that it doesn't always show useful examples for the more obscure SharePoint features, but it at least provides a basis that I can refer to when I look up the actual usage on the web on in books. I've only had to dig out .NET Reflector and figure out just what a particular method is doing once or twice.

I'm not sure it would be as good if it was a wiki; the .NET classes might be well-documented, but somehow I doubt the less-used (like some SharePoint stuff and the class in the example) would get the same treatment. Now, if MSDN documentation included the official MS documentation plus a wiki page (rather than just a comments thread), that might be more useful.


 
Jonathan Allen   12 Aug 08 - 11:15 AM

I gave up on the wiki when I realized that with every version all my comments are lost. (Well not lost, but very well hidden from anyone looking at pages for the newer version.)

 
mike   12 Aug 08 - 12:13 PM

@Jonathan -- I'll forward your comment to the wiki team. Seems like a legitimate, um, disincentive to using the wiki, I agree.

 
Jonathan Allen   12 Aug 08 - 1:09 PM

Thanks, that really means a lot to me.

I actually complained about it months ago, but going through the "proper channels" often means the people who care never hear the message.


 
Larry W Jordan Jr   13 Aug 08 - 9:31 AM

Thanks for the comments and debate on MSDN. I want to address a number of things in the post and clear some things up.

The Community Content that we enable for each article is more than offering just comments on the topic. It is designed to support embellishing the content with examples, pointers and other additions to improve the topic. We also enabled tagging through the same mechanism for discovery.

We have had a lot of prolific additions to the content from folks who add PowerShell and other scripts…
http://msdn.microsoft.com/en-us/library/system.decimal.aspx#CommunityContent

And helpers
http://msdn.microsoft.com/en-us/library/aa337083(SQL.90).aspx#CommunityContent

Just as an example of the diversity of the contributions. We allow edits and modifications, etc.

Specific to the versioning issue is a little more complicated matrix and it is on our radar to enable it <g/> Versioning across releases for Community Content adds an additional dimension of features to the UX itself and also needs to provide for a way to bring forward Community Content and Annotations based on the user selecting that it applies to a specific version or all past/future versions. I am working with this currently with my team.

Finally, the issue of being able to contribute articles to the library versus annotations only to existing topics is being developed right now. We are targeting the broader announcement of the features of this capability for the PDC and look forward to sharing more information on my blog as we get closer to the pilots.

http://blogs.msdn.com/innovation/

Larry W Jordan Jr - Product Unit Manager for the MSDN and TechNet Infrastructure and Services Team


 
Chris Slemp   14 Aug 08 - 9:06 PM

I'd like to chime in on the discoverability comments... I've just completed an informal evaluation with a dozen customers, who we asked to use MSDN Search for 12 days. We had only minor complaints and several converts as a result. In my experience talking to literally hundreds of customers about our search, those that are griping about it haven't tried it lately, or haven't noticed the new features we've added in recent months. Have a read of my post describing our recent study here. http://blogs.msdn.com/cslemp/archive/2008/08/12/12-technical-pros-evaluate-msdn-technet-search-for-12-days.aspx