You are here: NI Home > Support > Product Reference > Manuals > LabVIEW 8.2 Help

Organizing the documentation systematically helps users learn about the product, VI, or application. Different users have different documentation needs. End users of VIs fall into the following two classes—end users of top-level VIs and end users of subVIs. Each of these users have different documentation needs. This book addresses techniques for creating and organizing documentation that helps both of these classes of users. The format of user documentation depends on the type of product you create.

Systematically Organizing Documentation

To make documentation more helpful for the user, consider organizing the documentation in a systematic way. Divide the documentation into three categories—concepts, procedures, and reference material. Create documentation that reflects these three categories.

Documenting a Library of VIs

If the software you are creating is a library of VIs for use by other developers, such as an instrument driver or add-on package, create documents with a format similar to the LabVIEW Help. Because the audience is other developers, assume the audience has a working knowledge of LabVIEW. Create documentation that contains an overview of the contents of the package, examples of how to use the subVIs, and a detailed description of each subVI.

For each subVI, include information such as the VI name and description, a picture of the connector pane, and a picture of the data type description for each control and indicator on the connector pane.

To generate most of the documentation for VIs and controls, select File»VI Properties and select Documentation from the Category pull-down menu.

Select File»Print to print VI documentation in a format almost identical to the format used in the VI and function reference information in the LabVIEW Help. Use the Print dialog box to save the documentation to a file and to create documentation for multiple VIs at once.

Documenting an Application

If you are developing an application for users who are unfamiliar with LabVIEW, the documentation requires more introductory material. Create a document that provides system requirements, basic installation instructions, and an overview about how the package works. If the package uses I/O, include hardware requirements and any configuration instructions the user must complete before using the application.

For each front panel with which the user interacts, provide a picture of the front panel and a description of the major controls and indicators. Organize the front panel descriptions in a top-down fashion, with the front panel the user sees first documented first. You also can use the Print dialog box to create this documentation.