Introducing Just Enough Documentation

The Oracle Database User Assistance group is introducing “just enough documentation”, a combination of two content types, interactive diagrams and video. Our aim is to help you get started using Oracle’s products as quickly as possible through a combination of interactivity and visual presentation. Our first implementation of this approach is the Architectural Overview for Oracle Data Safe.

The interface accommodates three different learning styles.

At the top of the page, you can download the content for offline viewing or printing by clicking Show PDF. You can also advance through the content using the slide control buttons. Click Next to view the next slide, click Previous to back up one slide, and click First to return to the main slide.

The interactive diagram is a implemented as a graphic that you manipulate with your mouse. Click in a box that has an ellipses to explore details of a component in the diagram. A right-click in a component opens the related documentation.

The text below the diagram describes the highlighted components at a high level, and you can watch a demonstration of the components in action by clicking the video link.

If you like interactive diagrams we have others, including the Oracle Database single-instance and cluster technical architecture diagrams.

What do you think of this approach? How else can we improve the documentation? Let us know in the comments!


Leave a Reply