Visual Basic® Style Guide, The

How to Document

Professional Visual Basic documentation deals with the quality, the style, and the content of the writing.

Quality: Always Professional

One of the first Windows applications I purchased was a popular Personal Information Manager (PIM). The first thing I did, after ripping the shrink wrap off the package and running SETUP.EXE, was to sit down with the sizable user's guide and start reading. Sure, the writing was a little dry compared to a Tom Clancy novel, but what impressed me about this manual was the totality in which it described the application. The PIM, while generally easy to use, included features that would satisfy the most demanding and technically astute user. Once I started using the application, I did find a few places ...