Tom McGinn, Learning Architect, Database User Assistance, wrote an article about the introduction of “just enough documentation,” a combination of two content types – interactive diagrams and video. This concept was introduced by the Oracle Database User Assistance group with the aim of helping customers get started using Oracle’s products as quickly as possible through a combination of interactivity and visual presentation. The 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 implemented as a graphic that you manipulate with your mouse. Click in a box that has an ellipse 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.

For more information check out McGinn’s full article and comment on his post about what you think of the approach and how the documentation could be improved.

Additional Resources

COLLABORATE 20 will take place April 19-23, 2020 at the Mandalay Bay Resort and Casino in Las Vegas, Nevada! Don’t miss this chance to share inspiration, insights, and solutions with your peers, vendors, and the Oracle team! Register before March 6, 2020, to take advantage of Early Bird pricing.