Notes Overview – BridgeWorks Help Center

Trouble Viewing Images? Right-click on any image and select "Open in new tab" to view a larger version. You can also zoom in using Ctrl + Mouse Wheel for easier readability.

Summary

This article provides an overview of the Notes feature in VDM. Notes can be used to store View-specific information such as author details, change history, requirements, and other documentation directly within a View.

What Are Notes?

The Notes feature allows users to add and maintain documentation directly within a View. Notes are saved with the View file and can be used to provide important information about the View's purpose, design, maintenance, and usage.

Because Notes are stored within the View itself, they can be shared with other users when the View is distributed.

Common Uses for Notes

Use Case	Description
View Documentation	Document the purpose and intended use of a View.
Author Information	Record who created or maintains the View.
Request Details	Document who requested the View and any related requirements.
Change History	Maintain a record of updates and modifications.
Business Requirements	Store implementation notes, assumptions, and business logic.
Parameter Information	Document parameter requirements and usage instructions.

Accessing Notes

The Notes feature is located in the Tools section of VDM.

To access Notes:

Expand the Tools section.
Select Notes.

Working with Notes

To create or update Notes:

Open Notes from the Tools section.
Enter the information you want to associate with the View.
Save the View.

Note: Notes are stored within the View file and are specific to that View.

Best Practices

Recommendation	Description
Document the Purpose	Record why the View was created and how it should be used.
Include Author Information	Identify who created or currently maintains the View.
Track Changes	Record major modifications and updates.
Document Parameters	Include parameter requirements and expected values.
Record Business Logic	Document calculations, filters, and assumptions used within the View.

Additional Information

Notes are saved directly within the View file. Any user who opens the View will have access to the Notes associated with that View.