Visual Basic® Style Guide, The

What Is Documentation?

Documentation is the human-language version of your application's source code and user interface. Such documentation comes in various forms, each of which is intended for a unique audience. All these forms of software documentation share a common goal: to make the reader familiar with the application.

There are two primary types of documentation, internal documentation and external documentation. Internal documentation includes those reference materials that are written for those who will have access to the application source code or design components, such as a database designer. These writings assume a certain level of technical knowledge and expertise on the part of the reader. If the reader is interested in the source ...