Document your application in a page element

Many applications can benefit from a short, general documentation of what the application is/does and any special forms/views/agents that really make it work.

Many applications can benefit from a short, general documentation of what the application is/does and any special forms/views/agents that really make it work. We create a "page" in each application with a brief overall description of how the application works. The page is always named "Documentation."

We try to include one or two sentences about any critical forms/views/agents. We explain briefly if there are any lookups or other issues that could cause the application to break.

We find this especially useful in debugging another developer's work and when additional servers are created.

Design elements usually "explain" themselves, but it sometimes helps to have an overall picture of an application.

Do you have comments on this tip? Let us know.

This tip was submitted to the SearchDomino.com tip exchange by member Pamela DeGrand. Please let others know how useful it is via the rating scale below. Do you have a useful Notes/Domino tip or code to share? Submit it to our monthly tip contest and you could win a prize and a spot in our Hall of Fame.

Dig Deeper on Lotus Notes Domino Application Development

Start the conversation

Send me notifications when other members comment.

Please create a username to comment.

-ADS BY GOOGLE

SearchWindowsServer

Search400

  • iSeries tutorials

    Search400.com's tutorials provide in-depth information on the iSeries. Our iSeries tutorials address areas you need to know about...

  • V6R1 upgrade planning checklist

    When upgrading to V6R1, make sure your software will be supported, your programs will function and the correct PTFs have been ...

  • Connecting multiple iSeries systems through DDM

    Working with databases over multiple iSeries systems can be simple when remotely connecting logical partitions with distributed ...

SearchDataCenter

SearchContentManagement

Close