Jeff and .NET

The .NET musings of Jeff Putz

Sponsors

News

My Sites

Archives

Microsoft documentation fail

Before it sounds like all I do is complain, let me first say that the advances in C# 3.0, along with LINQ and ASP.NET AJAX, have made programming more fun than ever. I've spent a lot of time lately using all of this stuff on my own projects, and I'm having a great time. I'm going to make some lucky employer very happy (or annoyed because they're still using v1.1).

That said, the documentation situation is bad. It's better than it was circa 2004, but all of the rapid shipping and fragments of the .NET world are leaving the docs a mess. It starts with the MSDN site itself, which has much better search than it used to, but is still heavy and slow because of the treeviews. It also doesn't look right in Firefox, and doesn't retain your preference for programming languages.

The ASP.NET site (which, by the way, also beachballs Firefox on the Mac with every page load making it unusable) has the outline of the new features in v3.5 SP1, and presents you up front with video. Video is not particularly useful when you want to just get to the examples. I go to the link for the browser history feature, and, after the five second beachball, see nothing but a video. OK, so where is the link to the docs? I had to watch the video (which is painful because it's VB.NET, and the presenter is "rusty" on his VB), and then see that it involves using ScriptManager, so I finally can go to MSDN and look up the right methods. I get there and find no examples of how to use the history point related stuff. Lots of wasted time. I end up having to rely on Googling third parties for a decent reference.

About a year ago, maybe more, I recall looking at the mapping stuff for maps.live.com, and how you could integrate maps to your site. I remember it being a lot easier than what Google had at the time. So I go to the site, and start clicking around from the developer link and I can't find anything. All I get is stuff for the "Live Search API." So what is that, and what does it have to do with maps? Why is there a download link for an SDK? I just wanted to call your Javascript like I did last year and get a map in a div. Compare this non-obviousness with Google's page. You're two clicks from a simple HTML file that makes a map.

I'm a huge fanboy of Microsoft's, but this kind of thing frustrates me. I think the company needs a new role: Barrier Detection Monitor. This is a person who, in their product group, would look for things that make it harder for people to use the product. Too often there's something brilliant coming out of Redmond and it doesn't get the use or attention it deserves because of some kind of silly barrier.

Comments

funny wallpaper » Microsoft documentation fail said:

Pingback from  funny wallpaper » Microsoft documentation fail

# August 13, 2008 1:08 PM

J.R. Garcia said:

I couldn't agree more.

I don't know how many times I've browsed Microsoft's sites in search of certain documentation or examples and have ended up just using a search engine to lead me to someone's personal blog. I also couldn't tell you the number of times I've searched for a Microsoft download of some sort and ended up having to use a search engine to provide me with a download link.

I'm a Microsoft fanboy as well (although I've been really happy with Ubuntu lately), and it pains me to see such a great company make it hard for me to find a way to use their products.

# August 13, 2008 2:21 PM

Scott Galloway said:

Ok, Jeff...thanks for the feedback. Does this page cover what you need www.asp.net/.../readme

I'll get this highlighted better on the site...it is a bit hidden away right now...

# August 13, 2008 6:45 PM

Dev said:

I agree with you about the documentation... it's poor, slow and just a lot of the time completely unhelpful. And only part of the problem is the presentation, a lot of the content is shoddy too.

However, I struggle to agree with the "enjoyable-ness" of coding in ASP.NET - it is so slow to build and deploy debugging is a nightmare. With PHP you can just chimp till it's done. In ASP.NET a build and deploy might take 15, 20 seconds, by which time you forget what you're doing.

It's nice using c# functionality in web-pages but the web controls are dire- heavy, clunky, impossible to adapt without reinventing the wheel, and a complete no-no for integration with other tools.

Whoever thought it was a good idea for a framework to re-comile vanilla HTMl in your pages, hi-jacking your markup, inserting things in the hierarchy and renaming your element IDs?

After 3 weeks adding things to this list: www.aspotnet.org.uk - was the only way I kept myself from putting my fist through the window every time VS hung and I had to reboot.

It's experiences like this, along with allowing simply poor products like Vista and IE7 out of the door, which makes Microsoft worthy of its shame.

# August 21, 2008 5:50 PM

Jeff said:

I dunno... if you find debugging difficult, I think maybe you're doing it wrong. I find it really easy.

# August 21, 2008 5:59 PM
Leave a Comment

(required) 

(required) 

(optional)

(required)