Glossary · Safety information
Technical documentation
Also known as: product documentation, technical communication
German: Technische Dokumentation
In technical documentation practice, technical documentation is the controlled information describing a product or system for design, conformity, installation, operation, maintenance, service and disposal. It includes internal documentation for manufacturers and authorities as well as information for use supplied to users.
- Technical documentation
- Compliance
In one sentence
Technical documentation is the controlled information about a product for design, conformity, installation, operation, maintenance, service and disposal.
Example
The technical documentation of an integrated bottling line includes design drawings, the risk assessment and test reports kept by the manufacturer, and the operating and maintenance manuals delivered to the plant.
Explained in context
Context cards connect this term with others to answer one question. Also in British English and German.
- Three processing purposes when AI supports case handlingWhich processing purposes have to be kept apart when an AI system supports the handling of individual cases?UKDeutsch
- Agent fleet or agent swarm: what parallel activity showsWhat is the difference between an agent fleet and an agent swarm, and which of the two can an outside observer establish?UKDeutsch
- Workflow-scoped AI and open-ended agentsWhat is the difference between AI embedded in a defined workflow and an open-ended AI agent?UKDeutsch
- The agent master record as a documentation objectWhat should an agent master record for an AI agent contain?UKDeutsch
- Model behavior policy and model card: two documents, two time directionsWhat is a model behavior policy, and how does it differ from a model card?UKDeutsch
- Internal and external technical documentation: what "external" really meansDoes "external documentation" mean documentation that is published?UKDeutsch
- Six technical documentation models comparedHow do topic-based, task-based, EPPO, semantic, minimalist and structured documentation differ?UKDeutsch
How it applies
- Two audiences: Internal technical documentation, such as the technical file, proves conformity to authorities. External documentation, the information for use, enables users to work safely. Both must describe the same product version.
- Machinery law: The Machinery Regulation uses “technical documentation” for what the Machinery Directive calls the technical file. In everyday language, the term also covers user documentation.
- Governance: All parts need document control and traceability to engineering data, so that changes propagate.
- Metadata: Standards such as iiRDS describe delivered documentation with machine-readable metadata, which makes it usable in portals and assistants.
Technical documentation vs. technical documentation (AI Act)
Under the EU AI Act, technical documentation (AI Act) is a defined legal term: the Annex IV documentation that providers of high-risk AI systems draw up for authorities and notified bodies. It corresponds to the technical file in machinery law, not to user documentation. For AI in machinery, both are needed and should be maintained in one system.