Usage of the 
Standard in the EnduraDocs Manager
- Why we used the standard in the EnduraDocs Manager.
- Which parts of the standard we implemented.
- Which metadata attribute we implemented.
Completely developing the document management capabilities of revisions in the EnduraDocs Manager required a solid metadata standard and method to effectively
categorize documentation files. The Standard fulfilled our requirements providing a solid foundation
for our developing. As an additional benefit, it is an established standard with ISO
recognition and wide usage in CMS and other applications. This enhances a seamless
integration of the EnduraDocs Software into the software landscape of your
organization and the interoperability between authoring, content management, and
delivery systems. As an open standard, the standard relies on common vocabulary for information and keeps
our system independent of proprietary standards.
InformationUnits In the EnduraDocs Manager
The standard includes multiple
types of containers for documentation files or similar content falling under the
umbrella term InformationUnit. InformationUnits specialize on a content type and come with a predefined set of metadata. For example
Documents are for complete sections of your documentation or legal documentation like the CE
declaration of conformity. For the revisions in the EnduraDocs Manager we implemented
the selection of Document and metadata attribute from the standard that promised to be most useful for our use case.
- Document
-
Documents act like boxes that contain one PDF file, and provide it with metadata.
Revisions with Documents work similarly to a file management system, allowing you to categorize your
documentation by language and information type, and to assign additional
metadata for enhanced navigability. During manual revision creation, you use Documents to set up your revision structure.
- Topic
- An Topic describes a reusable, self-contained piece of content that covers one piece
of information. The usage is similar to the concept of modular topics used in
DITA or similar authoring frameworks. To use Topics in the EnduraDocs Manager you must package them as an Archive and then create a revision based on it. You
cannot create Topics manually in the EnduraDocs Manager.
Metadata Overview
| Description | Used For | |
|---|---|---|
| DocumentType |
States which type of information an Document contains. Typical values for an DocumentTypes are assembly instructions or eC declaration of conformity. An
Document can have multiple DocumentTypes if they apply. |
|
| Component | Connects the Document to a part of your device. This allows you to differentiate between
Documents with the same information type (DocumentType) that belong to different parts of your device. Typical components
would be pump, motor, control panel. |
|
| Confidentiality Level | Indicates that the Document contains sensitive or internal documentation files giving you additional
control on who can access them in the EnduraDocs Viewer or Documentation Portal. To make the documentation files assigned to a Document publicly accessible (after publishing) its set the confidentiality level
to Public. If you set it to Restricted, access to the documentation files assigned
to the Document is prevented for operating personnel that are not on the e-mail
whitelist of your workspace. |
|
| TopicType |
States which type of information an Topic contains.
|
|
| Language | States the language of the documentation file. |
|