How did we improve Data Harmony documentation for the 3.9 software release? Glad you asked…
In 2014, we improved the instruction manuals significantly – to be more comprehensive without being harder on the eyes! We upgraded the documentation to be even clearer, more consistent and complete than before, while removing extraneous material.
Data Harmony customers will find that the software Guides are now boosted by A) better content, B) clearer page-layouts, and C) more navigation features.
- Overview section presents a less-technical descriptionof what the Data Harmony module is accomplishing and how
- Instructions for doing tasks in interfaces are streamlined, with more tips for the frequent user
- Glossary no longer contains Data Harmony software definitions mixed in alongside general thesaurus/indexing definitions. Now there are two highly focused knowledge resources to help our users directly:
- ‘Thesaurus Master® and MAIstro™ Glossary’ defines terminology you need to know to gain the greatest advantage while using either program to develop or administer a controlled vocabulary
- ‘M.A.I.™ Glossary’ defines terminology that you need to know in order to work with a rule base for subject-indexing text
- A recent emphasis by development programmers on customizing the use of API calls to meet specialized customer goals is now reflected in documentation for several ‘Data Harmony extensions,’ available for sale this year for the first time – such as Search Harmony & Recommender, Inline Tagging, Semantic Fingerprinting, Metadata Extractor, and Smart Submit. User guides for these Data Harmony Web services/extensions contain implementation examples that illustrate the software in action, with corresponding explanations
The API calls offer a method for system administrators to facilitate ongoing Web services for Data Harmony users in an interface (or through machine-to-machine automated operations)
Clearer Page Layouts
- Data Harmony onscreen interface tabs, button-names, menu options, dialog boxes, text-boxes, and actual computer code examples: each category is presented in a different emphasis and font style in the software instructions, to reduce confusion for the new reader
More Navigation Features For Increased Accessibility
- Every manual has more internal cross-references than before, providing the reader with convenient spots to move directly to a related section and bypass information they are already familiar with
- Every instruction manual displays PDF bookmarks in a pane to the left of the written page in all major sections – accessible from anywhere in the document. You can effectively navigate backwards or forwards to any section you need from any page of the guide, anytime, without the extra step of consulting the full Table of Contents