Handlung
action
Use the relates-to-action property to create a reference from an information unit to an action.
atomic manipulation of an object by a participant
Verwaltungsmetadaten
administrative metadata
Not intended to be used directly. Use the subclasses instead.
information that allows the management of iiRDS resources
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.
product life cycle phase that follows 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.
information subject that covers specific content in lists or overviews
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.
part used as a constituent in an assembled product, system or plant
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 information which helps users understand the structure or essential principles of a product, interface, or task
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.
information subject that covers applicable standards or the fulfilment of a product requirement
Produktentstehung
design and realization
product life cycle phase from environment analysis and ideation through production
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.
node in a tree-like, ordered collection
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'.
type of information arranged in a hierarchically ordered list of elements built by a root node and its subordinate nodes
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.
information unit that consists of an ordered set of information intended by the sender to be regarded as an entity
Metadaten der Dokumentation
documentation metadata
information that describes the context to which iiRDS resources apply
Dokumentart
document type
Document types define the intended purpose of a document.
type of information arranged in a document defined with respect to its specified purpose, function, and form of presentation
Stillstandzeit
down time
period of time during which an item is not in condition to perform its intended function
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.
something noticeable that takes place at a given location and point in time
Lebenszyklus-Status einer Informationseinheit
information unit lifecycle status
The status value is referenced using has-content-lifecycle-status-value.
stage of an information unit in the information development process
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.
categorical denomination of the information unit life cycle stage
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 a resource in an external system
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.
organizational origin of an identifier that is assigned to an iiRDS identity
Identitäts-Typ
identity type
The type of identity contained by the domain.
distinguished set of identifiers that are assigned to an iiRDS identity
Externe Klassifikation
external classification
External classifications may be assigned to information objects, information units, product variants, product features and components. Typically, external classifications are used to include metadata from other standards. Examples: ECLASS and CDD (IEC 61360) for product classfication and DCC (IEC 61355) or VDI 2770 for document classification.
External classification of an iiRDS domain entity. Each classification must be related to the classification domain within which it is unambiguous.
Externe Klassifikationsdomäne
external classification domain
A classification domain relates to a party, meaning a company or organization. The party is the owner or custodian of the domain.
domain of an external classification that is assigned to an iiRDS entity
Klassifikationstyp
classification type
The type of classification contained by the domain.
type of an classification that is assigned to an iiRDS domain entity
Formular
form
Examples of forms are service reports, field reports, and user feedback.
topic type that provides information in pre-defined fields
Formalität
formality
Examples of formality subjects are license terms and warranty conditions.
information subject that covers contractually relevant elements
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.
information unit that requires additional context
Fragmentselektor
fragment selector
selector that defines a part of content by a single identifier
Funktionalität
functionality
information subject that covers specific capabilities of the product
Funktionale Metadaten
functional metadata
information used to implement advanced content delivery scenarios and content assemblies for specific purposes
iirdsDomainEntity
any resource within the iiRDS domain
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.
version- and language-independent abstraction of an information unit
Informationsthema
information subject
Not intented to be used directly. Use the subclasses instead.
thematical characteristic of content
Informationsart
information type
Not intented to be used directly.
characteristic of content
Informationseinheit
information unit
Not intended to be used directly. Use the subclasses Package, Document, Topic, and Fragment instead.
piece of digitally encoded information
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
Instances have a maintenance frequency and an optional maintenance duration.
period of time between scheduled maintenance operations
Ende einer Verzeichnisstruktur
end of Directory node
closing element in a chain of directory nodes
Paket
package
There is exactly one Package instance within an iiRDS package. It holds general metadata on the overall iiRDS package.
information unit that bundles other information units for exchange
Akteur
party
Detailed information about a party may be specified in a vCard.
person, organization, or system
Akteursrolle
party role
Examples of party roles: manufacturer, author, inspector.
responsibility of a person or organization
Planungszeit
planning time
period of time required for or resulting from a specific task
Prozess
process
information subject that covers structured activities carried out to achieve a specific goal
Produktmerkmal
product feature
product characteristics
Produkteigenschaft
product property
Examples: dimensions, voltage, power, weight.
invariable characteristic of a product whose value is fixed once the product is defined
Produktfunktion
product function
Examples: starting a phone call, ending a phone call, ringing.
capability of a product or a component which is specific or required for the intended product task
Produktlebenszyklusphase
phase of product lifecycle
defined period in the evolution of a product from the conceptual idea to its ultimate disposal
Produktmetadaten
productMetadata
information about a product or component
Produktvariante
product variant
Examples: a specific model in a series or an individually manufactured good.
item or service offered on the market and designed to meet the needs or wishes of customers
In Nutzung nehmen
putting to use
product life cycle phase after production in which a product is set up for its intended use
Qualifikation
qualification
proficiency, competence, or expertise exhibited by an individual
Bereichsselektor
range selector
selector that defines the start point and the end point of a part of content
Referenz
reference
Examples are parameter lists, tables with technical data, UI control overviews, and parts lists.
Inhaltsausprägung
rendition
content of an information unit in a specific format
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.
set of connected behaviors, privileges, and obligations associated with a party
Sicherheit
safety
information subject that covers content which helps to avoid risk
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.
safety-related information that warns about hazards and instructs on how to avoid them
Selektor
selector
pointer to the content of a rendition
Kenntnisstufe
skill level
Describe the levels of ability required to carry out a specific task described in the technical documentation.
degree of qualification of an individual
Hilfsmittel
supply
physical object used by an actor that performs work tasks described in technical documentation
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 provides procedures and action steps to be followed or considered
Technische Daten
technical data
Not intended to be used directly. Use instances of this class instead.
information subject that covers qualitative and quantitative characteristics of technical objects
Technische Übersicht
technical overview
Examples are circuit diagrams, flow diagrams, software interface overviews, and pneumatic diagrams.
information subject that covers the technical structure of a product
Topic
topic
The resource of a topic is a file in the iiRDS package.
information unit that covers a single subject
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.
type of information determined according to functional principles
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.
topic type that provides an explanation for symptoms, diagnosis, and resolution of problems
Nutzung
use
product life cycle phase in which the product is supposed to realize its function
Arbeitszeit
working time
period of time that is required for conducting a specific task
Erstellungsdatum
date of Creation
date of creation of the resource
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
Cardinality: http://iirds.tekom.de/iirds#ContentLifeCycleStatus [0..1]
Auslaufdatum
expiry date
date and time on which the given content lifecycle status becomes invalid
Letztes Änderungsdatum
date of last modification
date and time of an information unit's last change
Vergabedatum
status date
date and time of a lifecycle status's last change
description
Typically a free-text acount of the resource
account on the resource
Cardinality: http://iirds.tekom.de/iirds#iirdsDomainEntity [0..*]
Dauer
duration
span of time
Cardinality: http://iirds.tekom.de/iirds#PlanningTime [1]
Format
format
media type of the rendition
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 of media formats allowed in an iiRDS package
Cardinality: http://iirds.tekom.de/iirds#Package [0..1]
Wartungsfrequenz
maintenance frequency
intended interval between recurring maintanance tasks
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.
unique name of the resource within a given domain
Cardinality: http://iirds.tekom.de/iirds#Identity [1]
Klassifikationsbezeichner
classification identifier
Recommended best practice is to classify the resource by means of a string conforming to a non-IRI identifier in an external classification domain.
classification identifier of the resource within an external classification domain
Cardinality: http://iirds.tekom.de/iirds#ExternalClassification [1]
Klassifikationsversion
classification version
Recommended best practice is to use the version or release date of the external classification.
version of the external classification
Cardinality: http://iirds.tekom.de/iirds#ExternalClassification [0..1]
iirdsAttribute
property with a literal value
iiRDS Version
iiRDS version
Current version is 1.0.
iiRDS version with which the iiRDS package complies
Cardinality: http://iirds.tekom.de/iirds#Package [1]
Sprache
language
Controlled vocabulary according to RFC 4646.
identifier of the content's language
Cardinality: http://iirds.tekom.de/iirds#InformationUnit [0..*]
Revision
revision
version of an information unit
Rechte
rights
declaration of specific rights regarding the usage of the information
Kommentar zum Status
status comment
note on a content lifecycle 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 of a file in an iiRDS package that contains the content of a rendition
Synonym
synonym
word or phrase that means exactly or nearly the same as another word or phrase in the same language
Titel
title
Typically, a title will be a name by which the information unit is formally known.
name of the information unit
geeignet für Dokumentart
applicable for document type
Example: topics that are suitable for the installation instructions.
information unit's property that references a document type the information unit is suitable for
hat Zusammenfassung
has abstract
summary of the resource
hat Komponente
has component
property that references a component
Cardinality: http://iirds.tekom.de/iirds#Component [0..*]
hat Beziehung zu Bearbeitungsstatus
relates to content lifecycle status
information unit's property that references its content lifecycle status
hat Statuswert
has status value
content lifecycle status's property that references its value
Cardinality: http://iirds.tekom.de/iirds#ContentLifeCycleStatus [1]
hat Verzeichnisstrukturtyp
has directory structure type
directory node's property that references its node type
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.
document's property that references its document type
Cardinality: http://iirds.tekom.de/iirds#Document [1..*]
hat Endselektor
has end selector
A range selector must reference one start and one end selector.
range selector's property that references the end of its range
Cardinality: http://iirds.tekom.de/iirds#RangeSelector [1]
hat Ereigniscode
has event code
property to identify an event
Cardinality: http://iirds.tekom.de/iirds#Event [0..1]
hat Ereignistyp
has event type
event's property that references its type
hat als erstes Kindelement
has first child
directory node's property that references the first directory node on the next subordinate level in a directory structure
hat komplexen Identifier
has complex identifier
iiRDS resource's property that references an identifier
Cardinality: http://iirds.tekom.de/iirds#InformationObject [0..*]
Cardinality: http://iirds.tekom.de/iirds#ProductVariant [0..*]
Cardinality: http://iirds.tekom.de/iirds#Rendition [0..*]
hat Identifier-Domain
has identifier domain
identifier's property that references the domain in which it is unique
hat Identifier-Typ
has identifier type
identity domain's property that references its identifier type
Cardinality: http://iirds.tekom.de/iirds#IdentityDomain [0..1]
hat Klassifikations-Domain
has classification domain
references the domain that a classification refers to
hat externe Klassifikation
has external classification
references an external classification
Cardinality: http://iirds.tekom.de/iirds#ProductFeature [0..*]
hat Klassifikations-Typ
has classification type
type of the classification or the class name
Cardinality: http://iirds.tekom.de/iirds#ClassificationDomain [0..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.
information unit's property that references its nature or subject
hat als nächstes Element
has next sibling
directory node's property that references the following directory node on the same hierarchy level in a directory structure
hat administrative Rolle
has administrative role
party's property that references its role
Cardinality: http://iirds.tekom.de/iirds#Party [0..1]
hat Zeit
has time
information unit's property that references the planning time
hat Inhaltsausprägung
has rendition
information unit's property that references its rendition
hat Selektor
has selector
rendition's property that references a selector
Cardinality: http://iirds.tekom.de/iirds#Rendition [0..1]
hat Startselektor
has start selector
range selector's property that references the start of its range
hat Thema
has subject
information unit's property that references its subject
hat Topictyp
has topic type
Defines the information type of a topic, e.g. task or learning.
information unit's property that references its topic type
iirdsRelationConcept
Not indented to be used directly.
iiRDS resource's property that references an iiRDS resource
ist Teil von Paket
is part of package
information unit's property that references the package to which it belongs
ersetzt
replaces
information unit's property that references the information unit to be replaced
ist Version von
is version of
Specifies that the information unit is a version or language variant of the information object.
information unit's property that references its information object
Zweck
purpose
reason for an information unit's lifecycle status
bezieht sich auf Handlung
relates to action
information unit's property that references an action
bezieht sich auf administrative Metadaten
relates to administrative metadata
iiRDS resource's property that references administrative metadata
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.
information unit's property that references a component
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.
information unit's property that references an event
bezieht sich auf funktionale Metadaten
relates to functional metadata
No intended to be used directly. Use the subclasses instead.
information unit's property that references functional metadata
bezieht sich auf Informationseinheit
relates to information unit
The related information unit is part of the directory.
directory node's property that references the corresponding information unit
hat Beziehung zu Akteur
relates to party
iiRDS resource's property that references a party
Cardinality: http://iirds.tekom.de/iirds#Component [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.
information unit's property that references a product feature
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.
information unit's property that references a product lifecycle phase
bezieht sich auf Produktmetadaten
relates to product metadata
information unit's property that references product metadata
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.
information unit's property that references a product variant
bezieht sich auf Qualifikation
relates to qualification
information unit's property that references a qualification
bezieht sich auf Hilfsmittel
relates to supply
information unit's property that references a supply
bezieht sich auf vCard
relates to vCard
party's property that references an organization or person
Beschaffung
acquisition
product life cycle phase of obtaining systems, products, or services as part of design and realization
Administrationsanleitung
administrator guide
document type that refers to information on the management of a technical system
Geltende Norm und Richtlinie
applicable standard
Examples: machinery directive, ATEX directive
information subject covering rules, guidelines, or definitions of product characteristics that need to comply with normative or legislative requirements
Montageanleitung
assembly instructions
document type that refers to information on how parts are put together to complete a specific product so that it fulfils its intended use
CE-Konformitätserklärung
cE declaration of conformity
document type that refers to a confirmation that a product complies with the applicable CE marking directives or regulations
Einrichtung
configuration
product life cycle phase of adapting settings to achieve the desired functionality of a product
Kontaktdaten
contact information
Contact information such as addresses, phone numbers, URLs.
information subject that covers information on how to contact a party
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 covering an assurance that the product complies with the EU Declaration of Conformity for CE marking
Außerbetriebnahme
decommissioning
product life cycle phase of shutting down a system at the end of its usage period
Design
design
product life cycle phase of designing systems, products, or services
Entwicklung
development
product life cycle phase of transfoming from design into a production-ready functional system, product or service
Fehlerdiagnose
diagnostics
product life cycle phase of identifying a fault and its cause whitin the use phase
Entsorgung
disposal
product life cycle phase spanning the process of elimination of a product or component
Notbetrieb
emergency operation
product life cycle of restricted operation of a system to protect it from damage
Störung
fault
product life cycle that spans the interruption of the intended operation of a system due to malfunction
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 that covers the use of a product or system in a way not intended by the supplier, but which can result from readily predictable human behaviour
The AfterUse class is a parent class for product lifecycle phases that occur after the active use of the product.
product life cycle phase following the active use of the product
information subject covering specific content in lists or overviews
topic type providing background information that helps users understand the structure or essential principles of a product, interface, or task
The Conformity class is a parent class for information subjects that describe content related to applicable standards or the conformity of the product.
information subject covering applicable law, standards, or the fulfilment of a product requirement
The DesignAndRealization class is a parent class for product lifecycle phases related to the design, construction, and realization of a product.
product life cycle phase from ideation through production
Stillstandszeit
The DownTime class is a parent class for time periods during which an equipment or machine is not functional or cannot work.
The Event class describes events that happen in the technical system. Examples are errors, malfunctions, and warnings.
Freigegeben
approved
content life cycle status value which indicates that the information of the resource is correct
Gelöscht
deleted
content life cycle status value which indicates that the information of the resource has been revoked
In Arbeit
in preparation
content life cycle status value which indicates that the information of the resource is still being edited
In Review
in review
content life cycle status value which indicates that the information of the resource is being checked for correctness
Veröffentlicht
released
content life cycle status value which indicates that the associated information of the resource has been approved and is ready for publishing
Review durchgeführt
reviewed
content life cycle status value which indicates that the information of the resource has been checked
Widerrufen
withdrawn
content life cycle status value which indicates that an already released information of the resource is not valid anymore
The Form class describes topics that contain information in pre-defined form fields. Examples of forms are service reports, field reports, and user feedback.
topic type providing information in pre-defined fields
Formalie
The Formality class is the parent class for information subjects that describe content related to official or legal documents.
The Functionality class is the parent class for information subjects that describe content related to specific functionalities of the product.
type of topic that provides learning content
The MaintenanceInterval class describes time intervals and durations for the scheduled maintenance of a technical system or its parts.
unknown
Autor
author
An author is the individual or the organization from which the referenced iiRDS domain entity originates.
party role of the party that edited the referenced information unit
Ersteller
creator
A creator is the individual or the organization that created the referenced iiRDS domain entity.
party role of the party from which an information unit originated
Beteiligter
contributor
A contributor is an individual or an organization that participated in the generation/change of the referenced iiRDS domain entity.
party role of the party that provides input to the making of an information unit
Kunde
customer
A customer is an individual or an organization that purchased or consumes the referenced iiRDS domain entity.
party role of the party that purchases or receives a product
Prüfer
inspector
An inspector is an individual or an organization that supervises or checks the referenced iiRDS domain entity and makes reports.
party role of the party that evaluates conformity with the requirements
Hersteller
manufacturer
The manufacturer is the individual or the organization that produces the referenced iiRDS domain entity.
party role of the party that designs or produces a product
Durchgeführt von
performed by
Describes the actor that is involved in changing the content lifecycle status.
party role of the party that changes the content life cycle status
Zulieferer
supplier
Describes the individual or the organization that provides the referenced iiRDS domain entity, e.g. a component.
party role of the party that provides products
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.
The Process class contains information subject for process-related information.
information subject that covers structured activities which are carried out to achieve a specific goal
The ProductFeature class is a parent class for characteristics and functions of a product or component.
The ProductProperty class describes a characteristic of a product or component.
The ProductFunction class describes a function that a product or component provides or implements.
The PuttingToUse class is a parent class for the product lifecycle phases related to putting a product or technical system to use.
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.
topic type that provides additional details for lookup
The Role class describes roles for users of the technical system and the associated technical information.
set of connected behaviors, privileges and obligations associated with a party
The Safety class contains information subjects related to safety.
The SkillLevel class describes custom skill levels that the users of the technical system and the associated technical information require.
generic supply
The Supply class is a parent class for supplies that are required for working tasks described in technical documentation.
physical object used by an actor performing work tasks described in technical documentation
Information that describes the technical characteristics of a product or component.
The TechnicalOverview class is a parent class for information subjects describing contents related to technical plans, diagrams, or the technical architecture of the product.
Troubleshooting information may comprise a description of the symptoms, the cause of the error, and a remedy for the error.
topic type that provides an explanation on symptoms, diagnosis, and resolution of problems
The Use class is a parent class for product lifecycle phases related to using a product or technical system.
generic working time
The WorkingTime class is a parent class for periods of time required for a specific working task.
Index
index
directory node type that refers to an ordered arrangement of entries, designed to enable users to locate information in information units
Installation
installation
product life cycle phase of setting up a product in the designated target environment so that it fulfils its intended use
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.
document type that refers to information on how to set up a product in the designated target environment so that it fulfils its intended use
Bestimmungsgemäße Verwendung
intended use
information subject that covers information which states the range of functions or foreseen applications defined and designed by the supplier of the product
Rechtlicher Hinweis
legal information
information subject that covers supplementary information referencing laws or regulations
Lizenzbedingung
license terms
information subject that covers a legal contract between two parties wherein the property owner gives permission to another party to use its intellectual properties
Abbildungsverzeichnis
list of figures
LOF
Type of directory
directory node type that refers to a list of visuals and their location within information units, generally in order of appearance
Codeverzeichnis
list of listings
LOL
directory node type that refers to a list of code snippets and their location within information units, generally in order of appearance
Tabellenverzeichnis
list of tables
LOT
directory node type that refers to a list of tables and their location within information units, generally in order of appearance
Wartung
maintenance
product life cycle phase of activities intended to retain or restore a system in or to operational state
Wartungsanleitung
maintenance instructions
document type that refers to information on procedures to be followed to ensure that a product remains in good working order
Herstellerinformation
manufacturer information
information subject that covers information on the manufacturer of the product
Bedienelement
control element
information subject that covers interaction elements in user interface
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.
document type that refers to information on the correct use of the product
Betrieb
operation
product life cycle phase in which a system carries out its designated functions
Teilekatalog
parts catalog
document type that refers to a list-style arrangement of spare part information
Produktidentifikation
product identification
information subject that covers information on identity and characteristics of products
Herstellung
production
product life cycle phase of manufacturing products
Produktbezeichnung
product name
information subject that covers the designation of a product
Kurzanleitung
quick reference guide
document type that refers to selected information facilitating product use within a short period of time
Reparatur
repair
product life cycle phase of rectification of damages and malfunctions
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.
document type that refers to information on how to fix a failure of a product
Anforderungsanalyse
requirement analysis
product life cycle phase in which understanding and prioritisation of necessary product characteristics is achieved
Einsatzbeschränkungen
restriction on use
information subject that covers information specifying under which conditions or in which manner the product shall not be used
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 covering a process comprising a risk analysis and risk evaluation of the product or their result
Sicherheitshinweis
safety instruction
information subject covering general safety-related information applying to a range of information units
Verkaufskatalog
sales catalog
document type that refers to a list-style arrangement of information relevant for product selection and ordering
Lieferumfang
scope of delivery
information subject that covers all work, services, materials, completed products, and documentation that the supplier shall provide to the purchaser according to the purchase order
Garantiebedingungen
warranty conditions
information subject that covers the specific terms of a promise given by a manufacturer or supplier to a purchaser to properly repair, replace or refund a faulty product
Spezifikation
specification
document type that refers to information on technical properties of products
Symbol
symbol
information subject that covers an assembly of visual designations, together with their names or explanations of their meaning
Inhaltsverzeichnis
table of contents
TOC
Directory type
directory node type that refers to a list of information units in logical order
Technischer Bericht
technical report
information subject covering a report of product conformity with legislative or normative requirements
Transportanleitung
transport instructions
document type that refers to instructions for the movement of products or their components from one location to another
Elektronisches Typenschild
electronic identification plate
Type of document (VDI 2770)
document type referring electronically readable label on a product or component that provides information on its identity and characteristics
Plan
plan
Type of document (VDI 2770).
document type that refers to technical plans for a component or machine
Zertifikat
certificate
Type of document (VDI 2770). Examples are ATEX certificates, acceptance reports, and material certificates.
document type that refers to a document attesting conformity with applicable regulations
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.
document type that refers to safety-related information
Stückliste
bill of materials
Type of document (VDI 2770). Examples are part list with part number, part description, order number, and references to other documents.
document type that refers to formal tabulation of the physical assemblies, subassemblies, and components needed to fabricate a product
Vertragliches Dokument
contractual document
Type of document (VDI 2770). Contractual documents include, among others, contracts, acceptance reports, and service conditions.
document type that refers to a binding agreement between parties
Technische Zeichnung/Diagramm
technical drawing/diagram
document type that refers to a visual that conveys information about how an object functions or is constructed
A technical drawing or diagram.
Identifikationsdokument
identification document
document type that refers to information on identity and characteristics of products
Identifies an object and provides descriptive or classifying information.
Gefahr
danger
See ANSI Z535.5
warning message that describes a hazardous situation which, if not avoided, will result in death or serious injury
Warnung
warning
warning message that describes a hazardous situation which, if not avoided, could result in death or serious injury
Vorsicht
caution
warning message that describes a hazardous situation which, if not avoided, could result in minor or moderate injury
Hinweis
notice
message that contains information considered important but not related to personal injury
If possible, use Danger, Warning, Caution, or Notice instead.
Artikelcode
article code
Examples of article code are material number, article number, or item number.
identity type of the manufacturer's reference number or other identifier for products or for parts of a product
Bestellcode
order code
Examples of order code are configuration number, product number, or code.
identity type of the manufacturer's unique procurement key
Produkttyp
product type
Examples of product type are labels of product variants and type or model.
identity type for products of the same series
GTIN
Global Trade Item Number (GTIN) is an identifier for trade items.
identity type of internationally coordinated, uniform and globally unique article number for products and services
EAN
European Article Number (EAN; also International Article Number, IAN) identifier for trade items.
identity type of the European article number according to ISO/IEC 15420
Instanz einer Objekt-URI
instance of object URI
A globally biunique serial number, for example, according to the stipulations made in DIN SPEC 91406.
identity type of the globally unique URI for the product instance
Seriennummer
serial number
A serial number, serial ID oder serial code identifying a single object instance.
identity type of the number used to identify an individual product instance
ECLASS Coded Name
classification type that references an ECLASS product classification by an international registration data identifier (IRDI) path
8-digit class code that references an ECLASS product classification
ECLASS IRDI
CDD Identifikator
CDD identifier
classification type that references a product classification in the Common Data Dictionary (CDD, IEC 61360)