Verwaltungsmetadaten
Administrative metadata
Not intended to be used directly. Use the subclasses instead.
Parent class for administrative metadata, such as status and identifier.
Nutzungsende
After use
Not intended to be used directly. Use the subclasses instead. For lifecycle phases not covered by the iiRDS standard subclasses, define custom subclasses.
Parent class for iiRDS standard definitions of product lifecycle phases that occur after the active use of the product.
IRI: required
Zusammenstellung
Collection
Not intented to be used directly. Use the subclasses instead. For collection subjects not covered by the iiRDS standard subclasses, define custom subclasses.
Parent class for information subjects representing collections of specific information, such as list of spare parts or maintenance plan.
IRI: required
Komponente
Component
Components may have relations to other components so that iiRDS Generators can build up a simple component hierarchy with iiRDS structures.
The iirds#Component may also be used as a docking point for external component definitions.
Describes a component of the technical system that the documentation refers to.
IRI: required
Beschreibung
Concept
Conceptual information helps users to map their existing knowledge to tasks and other essential information about a product or system.
Class of topic types that provide background that helps readers understand essential information about a product, interface, or task.
IRI: required
Konformität
Conformity
Not intended to be used directly. Use the subclasses instead. For information subjects not covered by the iiRDS standard subclasses, define custom subclasses.
Parent class for information subjects that describe content related to applicable standards or the conformity of the product.
IRI: required
Produktentstehung
Design and realization
Not intended to be used directly. Use the subclasses instead. For lifecycle phases not covered by the iiRDS standard subclasses, define custom subclasses.
Parent class for subclasses that describe product lifecycle phases related to the design, construction, and realization of a product.
IRI: required
Verzeichnisknoten
Directory node
A directory is a tree-like, ordered collection of information units. Directory nodes are the entries in the directory. Directories help the user to navigate through the information units. A table of contents is a typical example of a directory.
Ein Verzeichnis ist eine baumartig organisierte und geordnete Zusammenstellung von Informationseinheiten. Verzeichnisknoten sind die Einträge in dem Baum. Verzeichnisse dienen dem Benutzer als Navigationshilfe über die Informationseinheiten. Ein Inhaltsverzeichnis eines Dokuments ist ein typisches Beispiel eines Verzeichnisses.
A node in a directory
Ein Eintrag in einem Verzeichnis
IRI: optional
Verzeichnistyp
Directory node type
A directory represented by a directory root node and its sub nodes has a type such as 'table of contens' or 'list of figures'.
Ein Verzeichnis, das durch einen Wurzelknoten und seine untergeordneten Knoten aufgespannt wird, hat einen Typ wie 'Inhaltsverzeichnis' oder 'Abbildungsverzeichnis'.
Directory type
Verzeichnistyp
IRI: required
Dokument
Document
A document consists of one or more files. It can consist of topics. The resource is either a blank node (when there is no file representing the document) or a file in the iiRDS package.
A unit of information in an iiRDS package that represents a complete document.
IRI: required
Metadaten der Dokumentation
Documentation metadata
Not intended to be used directly. Use the subclasses instead.
Parent class for functional metadata and product metadata.
Dokumentart
Document type
Document types define the intended purpose of a document.
The type of a document.
IRI: required
Stillstandzeit
Down time
Type of planning time: Period of time during which a technical system is stopped, especially during setup for an operation or when making repairs.
IRI: optional
Ereignis
Event
Examples are errors, malfunctions, and warnings.
Use the relates-to-event property to create a reference from an information unit to an event.
Describes events that happen in the technical system
IRI: required
Lebenszyklus-Status einer Informationseinheit
Information unit lifecycle status
The status value is referenced using has-content-lifecycle-status-value.
Content lifecycle status of an information unit.
IRI: optional
Wert des Lebenszyklus-Status einer Informationseinheit
Value of the information unit lifecycle status
The value refers to the content status, for example whether it is approved or withdrawn.
Value of an information unit's lifecycle status. The value is set by involved parties, such as the manufacturer or supplier.
IRI: required
Identität
Identity
Complex identifiers may be assigned to information objects, information units, product variants, and components. Typically, identities are used to provide IDs from other systems. Examples: serial numbers for components and module IDs from content management systems for topics.
Complex identifier of an iiRDS domain entity. Each identifier must be related to the identity domain within which it is unambiguous.
IRI: optional
Identitäts-Domäne
Identity domain
An identity domain relates to a party, meaning a company or organization. The party is the owner or custodian of the domain.
Domain of an identifier that is assigned to an iiRDS domain entity.
IRI: required
Formular
Form
Examples of forms are service reports, field reports, and user feedback.
Class of topic types that contain information in pre-defined form fields.
IRI: required
Formalität
Formality
Examples of formality subjects are license terms and warranty conditions.
Parent class for information subjects that describe content related to official or legal documents.
IRI: required
Fragment
Fragment
Sections, tables, lists, paragraphs, and hazard statements are examples of fragments. Fragments assign metadata to parts of topic or document files in an iiRDS package. The parts are identified by a fragment selector.
A piece of information within a document or topic.
IRI: required
Fragmentselektor
Fragment selector
Points to a fragment in a physical resource.
Verweist auf Fragment in einer physikalischen Ressource.
IRI: optional
Funktionalität
Functionality
Parent class for information subjects that describe content related to specific functionalities of the product.
IRI: required
Funktionale Metadaten
Functional metadata
Not intended to be used directly. Use the subclasses instead.
Parent class for metadata supporting advanced content delivery scenarios and content assemblies for specific purposes.
iirdsDomainEntity
iirdsDomainEntity
Not intended to be used directly. Use the subclasses instead.
An entity of the iiRDS domain
Eine Entität der iiRDS-Domäne
Informationsobjekt
Information object
Only used if a version/language-independent equivalent to an information unit is required. The versioned information unit references the information object.
A version-independent and language-independent equivalent to an information unit.
IRI: required
Informationsthema
Information subject
Not intented to be used directly. Use the subclasses instead.
Type of information. Abstract base class of subjects that an information unit covers.
IRI: required
Informationsart
Information type
Not intented to be used directly.
Type of information. Abstract base class of document and topic type.
IRI: required
Informationseinheit
Information unit
Not intended to be used directly. Use the subclasses Package, Document, Topic, and Fragment instead.
A unit of information. Abstract base class for specific information units.
IRI: required
Lernen
Learning
Learning content may comprise learning plans, learning objectives, learning content details, summaries, and assessments.
Class of topic types for learning. Learning content may comprise learning plans, learning objectives, learning content details, summaries, and assessments.
IRI: required
Wartungsintervall
Maintenance interval
Instances have a maintenance frequency and an optional maintenance duration.
Type of planning time: Fixed time interval for the scheduled maintenance of a technical system or its parts.
IRI: optional
Ende einer Verzeichnisstruktur
End of Directory node
The end in a chain of directory nodes
Das Ende in einer verketteten Liste von Verzeichnisknoten
Paket
Package
There is exactly one Package instance within an iiRDS package. It holds general metadata on the overall iiRDS package.
A set of information in terms of documents and topics with their metadata.
IRI: required
Akteur
Party
Detailed information about a party may be specified in a vCard.
Party related to an iiRDS domain entity.
IRI: required
Akteursrolle
Party role
Examples of party roles: manufacturer, author, inspector.
Role of a party related to an iiRDS domain entity.
IRI: required
Planungszeit
Planning time
Not intended to be used directly. Use the subclasses instead.
Parent class for different types of planning time that may be referenced in technical documentation. Planning times describe periods of time required for or resulting from specific working tasks.
IRI: optional
Prozess
Process
Information subject for process-related information
IRI: required
Produktmerkmal
Product feature
Not intended to be used directly. Use the subclasses instead.
Parent class for characteristics and functions of a product or component.
IRI: required
Produkteigenschaft
Product property
Examples: dimensions, voltage, power, weight.
A characteristic of a product or component.
IRI: required
Produktfunktion
Product function
Examples: starting a phone call, ending a phone call, ringing.
A function that a product or component provides or implements.
IRI: required
Produktlebenszyklusphase
Phase of product lifecycle
Not intended to be used directly. Use the subclasses instead.
Parent class for standardized product lifecycle phases that technical documentation may refer to.
IRI: required
Produktmetadaten
ProductMetadata
Not intended to be used directly. Use the subclasses instead.
Parent class for product-related metadata.
IRI: required
Produktvariante
Product variant
Examples: a specific model in a series or an individually manufactured good.
A variation of a product with some specific characteristics or features.
IRI: required
In Nutzung nehmen
Putting to use
Not intended to be used directly. Use the subclasses instead. For lifecycle phases not covered by the iiRDS standard subclasses, define custom subclasses.
Parent class for subclasses that describe product lifecycle phases related to putting a product or technical system to use.
IRI: required
Qualifikation
Qualification
Not intended to be used directly. Use the subclasses instead.
Parent class for different types of skills and roles required for working tasks described in technical documentation.
IRI: required
Bereichsselektor
Range selector
Points to a range in a physical resource. Has a start and end point.
Verweist auf einen Bereich in einer physikalischen Ressource. Hat einen Start- und einen Endpunkt.
IRI: optional
Referenz
Reference
Examples are parameter lists, tables with technical data, UI control overviews, and parts lists.
Class of topic types that contain information that supports users as they perform a task, meaning data that is looked up rather than memorized.
IRI: required
Inhaltsausprägung
Rendition
Content of an information unit in a specific format
Inhalt einer Informationseinheit in einem bestimmten Format
IRI: optional
Rolle
Role
Describes a set of connected behaviors, privileges and obligations associated with users (humans, software processes or devices) of a system.
Menge von zusammenhängenden Verhaltensweisen, Berechtigungen und Verpflichtungen, die Nutzern (Menschen, Softwareprozesse oder Geräte) eines Systems zugeordnet sind.
Docking point for custom roles for users of the technical system and the associated technical information.
Andockpunkt für unternehmensspezifische Rollen für Anwender des technischen Systems und der dazugehörigen Informationen.
IRI: required
Sicherheit
Safety
Not intended to be used directly. Use the subclasses instead.
Information subject. Abstract base class for safety subjects.
IRI: required
Warnhinweis
Warning message
Warning messages usually consist of a hazard alert symbol, a signal word (such as "Danger", "Warning", "Caution", "Notice"),
a description of the potential hazard, and hints how to avoid the hazard.
Information subject. Description of situations where a potential hazard can occur.
IRI: required
Selektor
Selector
Pointer to a physical resource.
Verweis auf eine physikalische Ressource.
IRI: optional
Kenntnisstufe
Skill level
Describe the levels of ability required to carry out a specific task described in the technical documentation.
Docking point for custom skill levels that the users of the technical system and the associated technical information require.
IRI: required
Hilfsmittel
Supply
Not intended to be used directly. Use the subclasses instead.
Parent class for different types of supplies required for working tasks described in technical documentation.
IRI: required
Aufgabe
Task
Tasks provide instructions and may contain information on other aspects, such as requirements that must be fulfilled or safety instructions.
Class of topic types that contains procedural information for work activities.
IRI: required
Technische Daten
Technical data
Not intended to be used directly. Use instances of this class instead.
Information subject class. Information that describes the technical characteristics of a product or component in sufficient detail for assembly, integration, operation, and maintenance.
IRI: required
Technische Übersicht
Technical overview
Examples are circuit diagrams, flow diagrams, software interface overviews, and pneumatic diagrams.
Parent class for information subjects describing content related to technical plans, diagrams, or the technical architecture of the product.
IRI: required
Topic
Topic
The resource of a topic is a file in the iiRDS package.
A topic is a unit of information covering a single subject.
IRI: required
Topictyp
Topic type
Possible types include task, learning, and concept. Information units that represent topics may have one or more has-topic-type properties that define the topic's information type. Topics without a has-topic-type property are generic topics, with no specific type.
Defines the information type of an iiRDS topic.
IRI: required
Störungsbeseitigung
Troubleshooting
Typical troubleshooting topics contain sections with a description of the system's behavior or symptom, the cause for the error, and a remedy for the error.
Class of topic types. Troubleshooting topics contain corrective action information that helps to fix an error or remove a malfunction.
IRI: required
Nutzung
Use
Not intended to be used directly. Use the subclasses instead. For lifecycle phases not covered by the iiRDS standard subclasses, define custom subclasses.
Parent class for subclasses that describe product lifecycle phases related to using a product or technical system.
Produktlebenszyklusphase: Oberklasse für den Gebrauch eines Produkts.
IRI: required
Arbeitszeit
Working time
Type of planning time: Period of time that is required for a specific working task.
IRI: optional
Erstellungsdatum
Date of Creation
Date of creation of the information unit
Cardinality: http://iirds.tekom.de/iirds#InformationUnit [0..1]
Gültigkeitsbeginn
Effective date
Date and time on which the given content lifecycle status becomes valid.
Datum und Uhrzeit, an dem der vergebene Status gültig wird.
Cardinality: http://iirds.tekom.de/iirds#ContentLifeCycleStatus [0..1]
Auslaufdatum
Expiry date
Date and time on which the given content lifecycle status becomes invalid.
Datum und Uhrzeit, an dem der vergebene Status ungültig wird.
Cardinality: http://iirds.tekom.de/iirds#ContentLifeCycleStatus [0..1]
Letztes Änderungsdatum
Date of last modification
Specifies the date and time on which the information unit was last changed.
Cardinality: http://iirds.tekom.de/iirds#InformationUnit [0..1]
Vergabedatum
Status date
Specifies the date and time on which content lifecycle status was changed.
Cardinality: http://iirds.tekom.de/iirds#ContentLifeCycleStatus [0..1]
Beschreibung
Description
Typically a free-text acount of the resource
An account of the resource.
Cardinality: http://iirds.tekom.de/iirds#iirdsDomainEntity [0..*]
Dauer
Duration
A span of time.
Dauer
Cardinality: http://iirds.tekom.de/iirds#PlanningTime [1]
Format
Format
Media type (MIME type) of the rendition
Medientyp (MIME-Type) der Inhaltsausprägung
Cardinality: http://iirds.tekom.de/iirds#Rendition [1]
Formateinschränkung
Format Restriction
Value "A" means that the package uses a restricted set of media formats ("iiRDS/A").
Restriction to the media formats used in the package.
Cardinality: http://iirds.tekom.de/iirds#Package [0..1]
Wartungsfrequenz
Maintenance frequency
Maintenance frequency
Wartungsfrequenz
Cardinality: http://iirds.tekom.de/iirds#MaintenanceInterval [1]
Bezeichner
Identifier
Recommended best practice is to identify the resource by means of a string conforming to a formal identification system.
An unambiguous reference to the resource within a given context.
Eine eindeutige Referenz auf die Resource in einem gegebenen Kontext.
Cardinality: http://iirds.tekom.de/iirds#Identity [1]
iirdsAttribute
iirdsAttribute
Not intended to be used directly. Use the subclasses instead.
Property type. Abstract base class of all properties with literal values.
iiRDS Version
iiRDS version
Current version is 1.0.
iiRDS version to which the iiRDS package complies.
iiRDS-Version, die das iiRDS-Paket erfüllt.
Cardinality: http://iirds.tekom.de/iirds#Package [1]
Sprache
Language
Controlled vocabulary according to RFC 4646.
A language of the resource.
Cardinality: http://iirds.tekom.de/iirds#InformationUnit [0..*]
Revision
Revision
Version of the information unit.
Cardinality: http://iirds.tekom.de/iirds#InformationUnit [0..1]
Rechte
Rights
Information about rights held in and over the resource.
Cardinality: http://iirds.tekom.de/iirds#InformationUnit [0..*]
Kommentar zum Status
Status comment
Comment describing the status change.
Anmerkungen im Zusammenhang mit der Vergabe des Status
Cardinality: http://iirds.tekom.de/iirds#ContentLifeCycleStatus [0..*]
Quelle
Source
The path is relative to the root directory of the package, e.g., "content/overview.html".
Relative path to the file containing the content of a rendition.
Cardinality: http://iirds.tekom.de/iirds#Rendition [1]
Synonym
Synonym
A word or phrase that means exactly or nearly the same as another word or phrase in the same language.
Cardinality: http://iirds.tekom.de/iirds#iirdsDomainEntity [0..*]
Titel
Title
Typically, a title will be a name by which the information unit is formally known.
A name given to the information unit.
Cardinality: http://iirds.tekom.de/iirds#InformationUnit [0..1]
geeignet für Dokumentart
applicable for document type
Example: topics that are suitable for the installation instructions.
Specifies that the information unit is suitable and can be used for specific types of documents.
Cardinality: http://iirds.tekom.de/iirds#InformationUnit [0..*]
hat Zusammenfassung
has abstract
Relates to a literal or information unit that provides an abstract/summary for the information unit.
Cardinality: http://iirds.tekom.de/iirds#InformationUnit [0..1]
hat Komponente
has component
Relates to a component that is part of another component.
Verweist auf eine Kompoente, die Teil einer anderen Komponente ist.
Cardinality: http://iirds.tekom.de/iirds#Component [0..*]
hat Beziehung zu Bearbeitungsstatus
relates to content lifecycle status
References the content lifecycle status of the information unit.
Cardinality: http://iirds.tekom.de/iirds#InformationUnit [0..*]
hat Statuswert
has status value
References the content lifecycle status value.
Cardinality: http://iirds.tekom.de/iirds#ContentLifeCycleStatus [1]
hat Verzeichnisstrukturtyp
has directory structure type
The nature of the directory.
Die Natur des Verzeichnisses
Cardinality: http://iirds.tekom.de/iirds#DirectoryNode [0..1]
hat Dokumentart
has document type
Documents have one or more document types. Documents without document types are unspecific documents.
The type of a document.
Cardinality: http://iirds.tekom.de/iirds#Document [1..*]
hat Endselektor
has end selector
A range selector must reference one start and one end selector.
References the end of a range in a file.
Cardinality: http://iirds.tekom.de/iirds#RangeSelector [1]
hat Ereigniscode
has event code
References the code of the event.
Cardinality: http://iirds.tekom.de/iirds#Event [0..1]
hat Ereignistyp
has event type
References the type of the event.
Cardinality: http://iirds.tekom.de/iirds#Event [0..1]
hat als erstes Kindelement
has first child
References the first directory node on the next sub level.
Verweist auf den ersten Verzeichniseintrag in der nächsten Unterebene.
Cardinality: http://iirds.tekom.de/iirds#DirectoryNode [0..1]
hat komplexen Identifier
has complex identifier
References a complex identifier.
Cardinality: http://iirds.tekom.de/iirds#Component [0..*]
Cardinality: http://iirds.tekom.de/iirds#InformationObject [0..*]
Cardinality: http://iirds.tekom.de/iirds#InformationUnit [0..*]
Cardinality: http://iirds.tekom.de/iirds#ProductVariant [0..*]
Cardinality: http://iirds.tekom.de/iirds#Rendition [0..*]
hat Identifier-Domain
has identifier domain
References the domain that an identifier is valid for.
Cardinality: http://iirds.tekom.de/iirds#Identity [1]
hat Informationsart
has information type
Not intended to be used directly. Use the child properties instead, such as has-document-type for documents and has-topic-type for topics.
The nature and subject of an information unit.
Cardinality: http://iirds.tekom.de/iirds#InformationUnit [0..*]
hat als nächstes Element
has next sibling
References the following directory node at the same hierarchy level in a directory structure.
Verweist auf den folgenden Verzeichniseintrag einer Verzeichnisstruktur auf gleicher Ebene.
Cardinality: http://iirds.tekom.de/iirds#DirectoryNode [0..1]
hat administrative Rolle
has administrative role
References the role that the party has with respect to an entity referencing the party.
Cardinality: http://iirds.tekom.de/iirds#Party [0..1]
hat Zeit
has time
References the planning time that is related to specific tasks or information described in an information unit.
Cardinality: http://iirds.tekom.de/iirds#InformationUnit [0..*]
hat Inhaltsausprägung
has rendition
Relates to a rendition of an information unit, meaning a physical file with content.
Verweist auf eine Inhaltsausprägung einer Informationseinheit.
Cardinality: http://iirds.tekom.de/iirds#InformationUnit [0..*]
hat Selektor
has selector
References the selector that is used to relate the information unit to a physical file with content.
Cardinality: http://iirds.tekom.de/iirds#Rendition [0..1]
hat Startselektor
has start selector
A range selector must reference one start and one end selector.
References the start of a range in a file.
Cardinality: http://iirds.tekom.de/iirds#RangeSelector [1]
hat Thema
has subject
References the subject of an information unit.
Verweist auf das Thema einer Informationseinheit.
Cardinality: http://iirds.tekom.de/iirds#InformationUnit [0..*]
hat Topictyp
has topic type
Defines the information type of a topic, e.g. task or learning.
The nature of an information unit.
Cardinality: http://iirds.tekom.de/iirds#InformationUnit [0..*]
iirdsRelationConcept
iirdsRelationConcept
Not indented to be used directly.
Base class for all relations in iiRDS.
Cardinality: http://iirds.tekom.de/iirds#iirdsDomainEntity [0..*]
ist Teil von Paket
is part of package
References the package in which the information unit was delivered.
Cardinality: http://iirds.tekom.de/iirds#InformationUnit [0..*]
ersetzt
replaces
References the information unit that is replaced by this information unit.
Cardinality: http://iirds.tekom.de/iirds#InformationUnit [0..1]
ist Version von
is version of
Specifies that the information unit is a version or language variant of the information object.
Relates an information unit to an information object.
Cardinality: http://iirds.tekom.de/iirds#InformationUnit [0..1]
Zweck
Purpose
Specifies the reason for changing the content lifecycle status.
Begründung zum Ausüben der Statusänderung.
Cardinality: http://iirds.tekom.de/iirds#ContentLifeCycleStatus [0..1]
bezieht sich auf administrative Metadaten
relates to administrative metadata
Not intended to be used directly. Use the subclasses instead.
Relates an iiRDS entity to administrative metadata.
Erzeugt Beziehung von einer iiRDS-Entität zu administrativen Metadaten.
Setzt eine iiRDS Entität in Beziehung mit administrativen Metadaten.
Cardinality: http://iirds.tekom.de/iirds#iirdsDomainEntity [0..*]
bezieht sich auf Komponente
relates to component
That means that the content of the information unit relates to a specific component of the documented product or component.
Relates to a component.
Cardinality: http://iirds.tekom.de/iirds#InformationUnit [0..*]
bezieht sich auf Ereignis
relates to event
That means that the content of the information unit refers to a specific event that occured in the product/system, e.g. an error.
Relates to an event.
Cardinality: http://iirds.tekom.de/iirds#InformationUnit [0..*]
bezieht sich auf funktionale Metadaten
relates to functional metadata
No intended to be used directly. Use the subclasses instead.
Relates an iiRDS entity to functional metadata.
Erzeugt Beziehung von einer iiRDS-Entität zu funktionalen Metadaten.
Cardinality: http://iirds.tekom.de/iirds#InformationUnit [0..*]
referenziert Informationseinheit
references information unit
The referenced information unit is part of the directory.
References an information unit from a directory node.
Cardinality: http://iirds.tekom.de/iirds#InformationUnit [0..1]
hat Beziehung zu Akteur
relates to party
Relates to a party, e.g. a company or an organization.
Cardinality: http://iirds.tekom.de/iirds#Component [0..1]
Cardinality: http://iirds.tekom.de/iirds#ContentLifeCycleStatus [0..1]
Cardinality: http://iirds.tekom.de/iirds#InformationUnit [0..1]
Cardinality: http://iirds.tekom.de/iirds#IdentityDomain [0..1]
Cardinality: http://iirds.tekom.de/iirds#ProductVariant [0..1]
bezieht sich auf Produkteigenschaft
relates to product feature
That means that the content of the information unit refers to or describes a specific product feature.
Relates to a product feature.
Cardinality: http://iirds.tekom.de/iirds#InformationUnit [0..*]
bezieht sich auf Produktlebenszyklusphase
relates to phase of the product lifecycle
That means that the content of the information unit describes activities or knowledge related to a specific lifecycle phase. Examples are operation and maintenance.
Relates to a product lifecycle phase.
Cardinality: http://iirds.tekom.de/iirds#InformationUnit [0..*]
bezieht sich auf Produktmetadaten
relates to product metadata
Relates to product metadata.
Cardinality: http://iirds.tekom.de/iirds#InformationUnit [0..*]
bezieht sich auf Produktvariante
relates to product variant
That means that the content of the information unit refers to or describes a specific variant of the product.
Relates to product variant.
Cardinality: http://iirds.tekom.de/iirds#InformationUnit [0..*]
bezieht sich auf Qualifikation
relates to qualification
Relates to a qualification that is required for the tasks or activities described in the information unit.
Cardinality: http://iirds.tekom.de/iirds#InformationUnit [0..*]
bezieht sich auf Hilfsmittel
relates to supply
Relates to a supply that is required for the tasks or activities described in the information unit.
Cardinality: http://iirds.tekom.de/iirds#InformationUnit [0..*]
bezieht sich auf vCard
relates to vCard
Relates to a vCard providing detailed information about the party.
Cardinality: http://iirds.tekom.de/iirds#Party [0..1]
Beschaffung
Acquisition
Lifecycle phase of a product during which services, goods, or works are acquired from an external source.
Administrationsanleitung
Administrator guide
Type of document. Contains instructions for the administration of a technical system.
Geltende Norm und Richtlinie
Applicable standard
Examples: machinery directive, ATEX directive
Information subject related to conformity. Describes content related to standards that a product needs to fulfill.
Montageanleitung
Assembly instructions
Type of document. Contains instructions enabling the operator to assemble a physical product so that it fulfills its intended use and does not endanger the health and safety of persons.
Dokumentenart. Enthält Anleitungen, die den Anwender dazu befähigen, ein physisches Produkt so zusammenzubauen, dass es die bestimmungsgemäße Verwendung erfüllt und die Sicherheit und Gesundheit von Personen nicht beeinträchtigt wird.
CE-Konformitätserklärung
CE declaration of conformity
Type of document. Created as a result of a procedure whereby the manufacture or authorized representative "ensures and declares" that the products concerned satisfy the requirements of the directives that apply to them.
Bestätigung des Hersteller (bzw. falls dieser seinen Sitz außerhalb der EU hat, sein Bevollmächtigter mit Sitz in der EU), dass ein von ihm in Verkehr gebrachtes Produkt den grundlegenden Gesundheits- und Sicherheitsanforderungen aller relevanten europäischen Richtlinien entspricht, also mit ihnen konform ist.
Einrichtung
Configuration
Lifecycle phase of a product describing activities related to configuring the settings of a technical system before use.
Kontaktdaten
Contact information
Contact information such as addresses, phone numbers, URLs.
Information subject. Contact information of the supplier.
Konformitätserklärung
Declaration of conformity
The Declaration of Conformity states that the product complies with the essential requirements of the relevant standards.
Information subject. Specifies that the information unit deals with the EU Declaration of Conformity for CE marking.
Außerbetriebnahme
Decommissioning
Lifecycle phase of a product describing the shut-down and transfer into a safe state.
Design
Design
Lifecycle phase of product design.
Entwicklung
Development
Lifecycle phase of a product progressing from detailed design to prototyping through pilot release to full product launch.
Fehlerdiagnose
Diagnostics
Lifecycle phase of a product containing procedures for locating errors.
Entsorgung
Disposal
Lifecycle phase of a product describing the elimination of components, mounted parts and lubricant considering the country-specific current law.
Notbetrieb
Emergency operation
Product lifecycle phase of a technical system in which the system's functionality is reduced to a minimum due to an error or emergency situation.
Störung
Fault
Product lifecycle phase of a technical system in which the intended use and operation of a technical system or software is interrupted due to an error or malfunction.
Phase im Produktlebenszyklus, in der Störungen des bestimmungsgemäßen Betriebes einer technischen Anlage, einer Software oder eines technischen Systems auftreten.
Vorhersehbarer Fehlgebrauch
Foreseeable misuse
Use of a product in a manner not intended by the producer or supplier but which may result from foreseeable human behavior. See EN 82079-1
Information subject. Foreseeable misuse of a product.
Nutzungsende
After use
The AfterUse class is a parent class for product lifecycle phases that occur after the active use of the product.
Generic instance of the AfterUse class.
Zusammenstellung
Collection
Information subject. Indicates that the content represents a collection of information assembled from different information units.
Beschreibung
Concept
Conceptual information helps users to map their existing knowledge to tasks and other essential information about a product or system.
Topic type that provides background that helps readers understand essential information about a product, interface, or task.
Konformität
Conformity
The Conformity class is a parent class for information subjects that describe content related to applicable standards or the conformity of the product.
Generic instance of the Conformity class.
Produktentstehung
Design and realization
The DesignAndRealization class is a parent class for product lifecycle phases related to the design, construction, and realization of a product.
Generic instance of the DesignAndRealization class.
Stillstandszeit
Down time
The DownTime class is a parent class for time periods during which an equipment or machine is not functional or cannot work.
Generic instance of the DownTime class.
Ereignis
Event
The Event class describes events that happen in the technical system. Examples are errors, malfunctions, and warnings.
Generic instance of the Event class.
Freigegeben
Approved
Content lifecycle status value; indicates that the content has been approved.
Gelöscht
Deleted
Content lifecycle status value; indicates that the content has been removed.
In Arbeit
In preparation
Content lifecycle status value; indicates that the content is not finished yet and is still being edited.
In Review
In review
Content lifecycle status value; indicates that the content is being reviewed.
Veröffentlicht
Released
Content lifecycle status value; indicates that the content has been released.
Review durchgeführt
Reviewed
Content lifecycle status value; indicates that the content has been reviewed.
Widerrufen
Withdrawn
Content lifecycle status value; indicates that the content has been withdrawn and is no longer valid.
Formular
Form
The Form class describes topics that contain information in pre-defined form fields. Examples of forms are service reports, field reports, and user feedback.
Generic instance of the Form class.
Formalie
Formality
The Formality class is the parent class for information subjects that describe content related to official or legal documents.
Generic instance of the Formality class.
Funktionalität
Functionality
The Functionality class is the parent class for information subjects that describe content related to specific functionalities of the product.
Generic instance of the Functionality class.
Lernen
Learning
Learning content may comprise learning plans, learning objectives, learning content details, summaries, and assessments.
Topic type that provides learning content.
Wartungsintervall
Maintenance interval
The MaintenanceInterval class describes time intervals and durations for the scheduled maintenance of a technical system or its parts.
Generic instance of the MaintenanceInterval class.
Autor
Author
An author is the individual or the organization from which the referenced iiRDS domain entity originates.
Instance of the PartyRole class describing the role of an actor related to an iiRDS domain entity.
Ersteller
Creator
A creator is the individual or the organization that created the referenced iiRDS domain entity.
Instance of the PartyRole class describing the role of an actor related to an iiRDS domain entity.
Beteiligter
Contributor
A contributor is an individual or an organization that participated in the generation/change of the referenced iiRDS domain entity.
Instance of the PartyRole class describing the role of an actor related to an iiRDS domain entity.
Kunde
Customer
A customer is an individual or an organization that purchased or consumes the referenced iiRDS domain entity.
Instance of the PartyRole class describing the role of an actor related to an iiRDS domain entity.
Prüfer
Inspector
An inspector is an individual or an organization that supervises or checks the referenced iiRDS domain entity and makes reports.
Instance of the PartyRole class describing the role of an actor related to an iiRDS domain entity.
Hersteller
Manufacturer
The manufacturer is the individual or the organization that produces the referenced iiRDS domain entity.
Instance of the PartyRole class describing the role of an actor related to an iiRDS domain entity.
Durchgeführt von
Performed by
Describes the actor that is involved in changing the content lifecycle status.
Instance of the PartyRole class describing the role of an actor related to an iiRDS domain entity.
Zulieferer
Supplier
Describes the individual or the organization that provides the referenced iiRDS domain entity, e.g. a component.
Instance of the PartyRole class describing the role of an actor related to an iiRDS domain entity.
Planungszeit
Planning time
The PlanningTime class describes different types of planning times that may be referenced in technical documentation, for example time required for or resulting from specific working tasks.
Generic instance of the PlanningTime class.
Prozess
Process
The Process class contains information subject for process-related information.
Generic instance of the Process class.
Produktmerkmal
Product feature
The ProductFeature class is a parent class for characteristics and functions of a product or component.
Generic instance of the ProductFeature class.
Produkteigenschaft
Product property
The ProductProperty class describes a characteristic of a product or component.
Generic instance of the ProductProperty class.
Produktfunktion
Product function
The ProductFunction class describes a function that a product or component provides or implements.
Generic instance of the ProductFunction class.
In Nutzung nehmen
Putting to use
The PuttingToUse class is a parent class for the product lifecycle phases related to putting a product or technical system to use.
Generic instance of the GenericPuttingToUse class.
Referenz
Reference
The Reference class describes a topic type containing information that supports users as they perform a task, meaning data that is looked up rather than memorized. Examples are parameter lists, tables with technical data, UI control overviews, and parts lists.
Generic instance of the Reference class.
Rolle
Role
The Role class describes roles for users of the technical system and the associated technical information.
Generic instance of the Role class.
Sicherheit
Safety
The Safety class contains information subjects related to safety.
Generic instance of the Safety class.
Kenntnisstufe
Skill level
The SkillLevel class describes custom skill levels that the users of the technical system and the associated technical information require.
Generic instance of the SkillLevel class.
Hilfsmittel
Generic supply
The Supply class is a parent class for supplies that are required for working tasks described in technical documentation.
Generic instance of the Supply class.
Aufgabe
Task
Tasks provide instructions and may contain information on other aspects, such as requirements that must be fulfilled or safety instructions.
Topic type that contains procedural information for work activities.
Technische Daten
Technical data
Information that describes the technical characteristics of a product or component.
Generic instance of the TechnicalData class.
Technische Übersicht
Technical overview
The TechnicalOverview class is a parent class for information subjects describing contents related to technical plans, diagrams, or the technical architecture of the product.
Generic instance of the TechnicalOverview class.
Störungsbeseitigung
Troubleshooting
Troubleshooting information may comprise a description of the symptoms, the cause of the error, and a remedy for the error.
Topic type that contains corrective action information that helps to fix an error or remove a malfunction.
Nutzung
Use
The Use class is a parent class for product lifecycle phases related to using a product or technical system.
Generic instance of the Use class.
Arbeitszeit
Generic working time
The WorkingTime class is a parent class for periods of time required for a specific working task.
Generic instance of the WorkingTime class.
Index
Index
Index directory type
Verzeichnistyp Index
Installation
Installation
Lifecycle phase of a product containing procedures for installing and setting up a software or IT system.
Installationsanleitung
Installation instructions
For physical products: instructions enabling the operator to assemble and electrically connect a physical product so that it fulfills its intended use and does not endanger the health and safety of persons. For IT products: Instructions enabling the administrator to set up and potentially configure a program or new version on a computer so that does not endanger data security.
Type of document. Contains instructions enabling the operator or administrator to assemble or install a physical product or software so that it fulfills its intended use.
Bestimmungsgemäße Verwendung
Intended use
Information subject: Legal concept outlining the field of application specified in matters of design and construction of the machinery which is described in the operating instructions/technical documentation, including considerations of the reasonable foreseeable use and potential misuse.
Informationsthema: Rechtlicher Begriff für den bei der Konzeption und Konstruktion einer Maschine festgelegten Einsatzbereich, der in der Betriebsanleitung/Technischen Dokumentation beschrieben wird und auch Überlegungen zur vernünftigerweise vorhersehbaren Verwendung bzw. zu möglicher Fehlverwendung beinhaltet.
Rechtlicher Hinweis
Legal information
Information subject for legal information.
Lizenzbedingung
License terms
Information subject describing licensing conditions.
Abbildungsverzeichnis
List of figures
LOF
Type of directory
List of figures
Abbildungsverzeichnis
Codeverzeichnis
List of listings
LOL
Type of directory
Code listing
Verzeichnistyp für Programmcode
Tabellenverzeichnis
List of tables
LOT
Type of directory
List of tables
Tabellenverzeichnis
Wartung
Maintenance
Lifecycle phase of a product that describes activities for moving or conveying the product from one place to another.
Wartungsanleitung
Maintenance instructions
Type of document. Contains instructions for retaining or restoring a piece of equipment, machine, or system to the specified operable condition.
Herstellerinformation
Manufacturer information
Information subject. Information about the manufacturer of a product like name and address.
Bedienelement
Control element
Information subject. Describes a device that a person can use to influence a machine or plant.
Betriebsanleitung
Operating instructions
The instructions in this document type enable the user to operate a device, machine, or software considering the reference use as well as the safety and health regulations for the product.
Anleitung, die den Anwender dazu befähigt, ein Gerät, eine Maschine oder eine Software so zu betreiben, dass das Gerät oder die Maschine die bestimmungsgemäße Verwendung erfüllt und die Sicherheit und Gesundheit von Personen nicht beeinträchtigt wird.
Type of document. Contains instructions for operation and use of a technical system.
Betrieb
Operation
Lifecycle phase of a product in which a technical product or system is actively used and operated.
Teilekatalog
Parts catalog
Type of document. Contains listings of product names and their part numbers and graphics which are necessary for the aftersales service, but do not include prices or availabilities.
Produktidentifikation
Product identification
Information subject: Describes a name plate or similar that identifies the product.
Herstellung
Production
Lifecycle phase of a product in which the product is manufactured.
Produktbezeichnung
Product name
Information subject. Contains the name of the product.
Kurzanleitung
Quick reference guide
Type of document. Describes a short document that contains selected instructions for a specific user group or purpose.
Reparatur
Repair
Lifecycle phase of a product that describes activities for restoring the product to a working and sound condition after damage or wear and tear.
Reparaturanleitung
Repair instructions
The instructions in this document type enable the user to repair a device, machine, or system considering the reference use as well as the safety and health regulations for the product.
Anleitung, die den Anwender dazu befähigt, ein Gerät oder eine Maschine so instandzusetzen, dass das Gerät oder die Maschine die bestimmungsgemäße Verwendung erfüllt und die Sicherheit und Gesundheit von Personen nicht beeinträchtigt wird.
Type of document. Contains instructions for restoring a product to a working condition.
Anforderungsanalyse
Requirement analysis
Lifecycle phase of a product belonging to the product design; comprises the analysis and definition of requirements for the future product.
Einsatzbeschränkungen
Restriction on use
Information subjects. Specifies that there are restrictions regarding the use of the product.
Risikobewertung
Risk assessment
A risk assessment determines the risks and hazards to life, environment, or machine functioning including a quantitative and qualitative estimate.
Information subject related to conformity. Specifies that the information unit contains information on the risk assessment made within the safety engineering of the product.
Sicherheitshinweis
Safety instruction
Information subject. Safety instructions explain to the user how to handle a product in a safe way.
Verkaufskatalog
Sales catalog
Type of document. Contains listings of available products of a producing company with consumers as the target group.
Lieferumfang
Scope of delivery
Information subject. Specifies the scope of the delivery.
Warranty conditions
Information subject. Contains the warranty conditions.
Spezifikation
Specification
Type of document. Contains requirements and/or statements describing properties and qualities of a product to be built or manufactured.
Symbol
Symbol
Information subject. Contains a list and explanation of symbols used in the documentation.
Inhaltsverzeichnis
Table of contents
TOC
Directory type
Table of contents
Inhaltsverzeichnis
Technischer Bericht
Technical report
Information subject related to conformity. Specifies that the information unit represents a report regarding the activities or working tasks related to the product.
Transportanleitung
Transport instructions
Type of document. Contains instructions for transporting the product or its components from one place to another.
Electronic identification plate
Type of document (VDI 2770)
Electronically readable label on a machine or component that provides information on the identity of the manufacturer and the product, as well as on the technical characteristics of the product.
Plan
Type of document (VDI 2770).
Describes documents containing technical plans for a component or machine.
Zertifikat
Certificate
Type of document (VDI 2770). Examples are ATEX certificates, acceptance reports, and material certificates.
Document of legal nature that contains and certifies product information, quality, and characteristics. Usually acknowledged with a signature.
Sicherheitsanleitung
Safety instructions
Type of document (VDI 2770). Examples are documents about the intended use of the product, protection/safety measures, safety equipment, and explosion prevention.
Contains general safety-related information provided by the manufacturer that must be considered during assembly, operation, maintenance, repair, and disassembly of the product. Safety information related to individual tasks is provided in the tasks.
Bill of materials
Type of document (VDI 2770). Examples are part list with part number, part description, order number, and references to other documents.
List of sub-components, sub-modules and parts of a product. The materials are listed with their identity and characteristics so that they can be identified within the product and procured.
Vertragliches Dokument
Contractual document
Type of document (VDI 2770). Contractual documents include, among others, contracts, acceptance reports, and service conditions.
Document that is part of or accompanies a contract.
Technische Zeichnung/Diagramm
Technical drawing/diagram
Type of document. Examples are flow diagrams and circuit diagrams.
A technical drawing or diagram.
Identifikationsdokument
Identification document
Type of document.
Identifies an object and provides descriptive or classifying information.
Gefahr
Danger
See ANSI Z535.5
Describes a hazardous situation which, if not avoided, will result in death or serious injury.
Warnung
Warning
See ANSI Z535.5
Describes a hazardous situation which, if not avoided, could result in death or serious injury.
Vorsicht
Caution
See ANSI Z535.5
Describes a hazardous situation which, if not avoided, could result in minor or moderate injury.
Hinweis
Notice
See ANSI Z535.5
Information considered important but not related to personal injury.
Warnhinweis
Warning message
If possible, use Danger, Warning, Caution, or Notice instead.
Warning or notice with unknown severity.