company logo

Just-in-time documentation

The ODABA development environment provides at many places just-in-time documentation features. Documentation is provided as hierarchical topic object and linked to the development unit just being accessed (e.g. object class, attribute or function parameter). Later on, topics can be composed to complex documents.

Documentation topics will be generated on the fly when the documenting feature has been activated (clicking the documentation button in the toolbar). When a schema or development resource gets the focus, a document topic will be created and associated with the resource. Browsing and editing document topics explicit becomes possible in the Thesaurus application.

Topic can be linked also to more than one development object, which display the same documentation in this case.