The "About Database" document

Use an "About Database" document to describe the purpose of a database. You can specify that the About document opens automatically when a user opens the database. To display this document, choose Help - About This Database.

The About document should include:

• The purpose of the database.
• The intended audience.
• The name and telephone number of the database manager.
• The date the database was implemented.
• Guidelines for its use.
• Network requirements if users must be connected to the network to perform certain tasks -- for example, if the application uses lookups that require a network connection.

Create a "Using Database" document to provide users with instructions on using various forms, views, and navigators in the database. To display this document, users choose Help ­ Using This Database.

• A brief overview of the application.
• The purpose of each view and its organizations.
• The purpose of each form and how to fill it out.
• The purpose of each agent, when to run it, and the anticipated results.
• The overall work process being automated, if appropriate, including what happens at each stage. When users fill out documents, they should understand what happens after the documents are saved, and what other users are expected to do.

1. In IBM® Lotus® Domino(TM) Designer, open the database you're designing.

2. In the Design pane, click Other - Database Resources.

3. Double-click "About Database Document" or "Using Database Document."

4. Write or edit the information. You can also create links, buttons, hotspots, and attachments. You can apply text styles, as you would for any IBM® Lotus® Notes® form.

5. Save the document.

To automatically display the "About Database" document

1. Choose File - Application - Properties and click the Launch tab.

2. Do any of the following:

• Select "On Database Open: Open About database document" so that this document always opens first.
• Select "Show About database document if modified" so that if you edit the document, it opens to users again.
• If you want each user to see the About document the first time they open the database, select "Show About database document when database is opened for first time."
• Select "On Web Open: Open About database document."

See Also

Providing online Help for an application
Creating context-sensitive Help for an application
Creating and displaying more detailed application Help
Writing Help for fields

Glossary