Tim Anderson's ITWriting [Valid RSS]

Tech writing blog

Blog Home RSS Archives ITWriting.com
Add to Feedburner Add to Bloglines Add to Newsgator Add to My Yahoo

June 7, 2006

Annoying documentation

Posted 4206 days ago on June 7, 2006

I came across the following documentation in Visual Studio's online help, when puzzling over the Advanced Compile Options dialog:

Generate serialization assemblies
Select Off, On, or Auto from the drop-down list. Off specifies that serialization assemblies not be generated. On specifies that serialization assemblies be generated. By default, this option is set to Auto.

This gem conveys zero additional information, beyond what you can already see in the dialog. The reason I looked up help was that I wanted to know what Auto means in this context. I'd also like to know where the assemblies are generated, and what if any additional steps I need to take in order to deploy them with my project and avoid the cost of generating them at runtime.

Time for some research I guess. This blog entry is a start, if you are wondering why you should care.

Still, my main point is about documentation. I see plenty of entries of this kind - actually, Microsoft is not the worst offender; Borland is much worse.

It is high time Microsoft and others implemented online help with a comment facility as in PHP.


No comments, be the first!

Comments are closed

Recent posts

Users plead with Borland to give up .NET
IE7 to be released 18th October,...
If Microsoft doesn't use UAC, why...
Google's unsettling lack of direction
Vista security: now prove it

Powered by bBlog