Welcome to MSDN Blogs Sign in | Join | Help

Browse by Tags

All Tags » Documentation Quality   (RSS)

Beware the Search-and-Replace

Posted Monday, February 04, 2008 10:20 AM by David Carlson
Related to recent amusement on the Cupertino effect ( spell-check mishaps ), Language Log has some great examples of " incorrections " caused by well-meaning bulk changes gone awry. Read More...
0 Comments

Feedback on Class Library Documentation

Posted Friday, June 15, 2007 1:11 PM by David Carlson
Miro Adamy has a blog entry on the shortcomings of the .NET Framework class library documentation on MSDN. See the posting and comments here: MSDN Documentation - the worst in class ? As it turns out, solutions to the majority of the design complaints Read More...
0 Comments

If it isn't documented . . .

Posted Wednesday, January 24, 2007 4:58 PM by David Carlson
Jeff Atwood has collected some good quotes, including one from DevDiv's own Mike Pope , about the importance of documentation. Also many good comments that have additional interesting points. I particularly enjoy the excellent rant about hardware documentation Read More...
0 Comments

Consistency Matters

Posted Friday, February 24, 2006 4:21 PM by David Carlson
Virtually everyone involved with documentation believes that consistency is a good thing. A recent article in the Journal of Technical Writing and Communication entitled "Evaluating the Effect of Iconic Linkage on the Usability of Software User Guides" Read More...
2 Comments
 
Page view tracker