Glossary
Technical documentation and information design glossary
Definitions of the terms behind the models of technical documentation described in the encyclopedia — topic-based and task-based documentation, Every Page is Page One, semantic documentation, minimalism and structured authoring — and of the concepts they rest on: topics and information types, task analysis, semantic markup, content models, controlled language and the structured formats used to implement them — and the cognitive and analysis tools documentation shares with other professions, such as the mental model of a user and the five whys. Philosophy, reasoning methods and mental models as thinking tools have a glossary pool of their own, The art of thinking.
2 · Topics and information design
Information foraging
In technical communication and human-computer interaction, information foraging is a theory that explains information seeking as behavior shaped by the value of the information sought and the effort needed to get it. Developed by Peter Pirolli and Stuart K. Card at Xerox PARC and published in Psychological Review in 1999, it borrows concepts from optimal foraging theory in ecology: readers move between information "patches", follow "information scent" given off by proximal cues such as link labels, headings, titles and metadata, and abandon a patch when the expected yield drops below what another patch promises. The theory is descriptive, not a standard or a method, and it predicts behavior rather than prescribing document structure. In documentation practice it is used as a rationale for making individual pages self-sufficient and for strengthening the cues by which readers judge, enter and leave a page.
Information foraging · Information scent · Findability · Every Page is Page One · Reading behavior
Definition and examplesInformation Mapping
German: Information Mapping
In technical communication, Information Mapping is a structured writing method that analyzes subject matter into small labeled units, classifies each unit by the reader question it answers, and presents the result in a standardized visual format. Its core building blocks are the information block (a labeled unit covering one idea) and the information map (a set of related blocks under a heading), with each block assigned an information type such as procedure, process, concept, principle, fact or structure. The method is applied in three steps — analyze, organize, present — guided by writing principles such as chunking, relevance, labeling and consistency. Information Mapping is also a registered trademark of Information Mapping, Inc., which offers training, certification and authoring software for the method.
structured writing · information types · chunking · modular content · technical communication
Definition and examplesTopic (technical communication)
German: Topic
In technical communication, a topic is a self-contained unit of content that covers a single subject and serves a single purpose, written so that it makes sense without the content that precedes or follows it. Topics are the units that authors write, review, approve, translate, reuse, and assemble into deliverables such as manuals, help systems, and content delivery portals. The general concept is not fixed by a single standard: structured formats such as DITA and iiRDS each define their own topic constructs, and in-house information models define topic types of their own. What the implementations share is the pairing of one title with one subject and one communicative purpose.
topic · topic-based authoring · structured authoring · information design · content reuse
Definition and examplesBottom-up information architecture
German: Bottom-up-Informationsarchitektur
In technical communication, a bottom-up information architecture is one that emerges from self-contained pages, their metadata and the links between them, so that readers who arrive at any page through search or a link can orient themselves and move on along related subjects, rather than from a single hierarchy imposed from the top, such as the table of contents of a book.
Information architecture · Every Page is Page One · Topics
Definition and examplesProgressive disclosure
In technical communication and interaction design, progressive disclosure is a design principle that presents the information or controls a reader needs for the current step and keeps the rest one deliberate step away, available on demand. Jakob Nielsen's 2006 description of the pattern — deferring advanced or rarely used features to a secondary screen so that applications are easier to learn and less error-prone — states its purpose: lower the entry cost for occasional users without removing capability for experts. In documentation it appears as short overviews that link to detail, expandable sections, layered help, tooltips and reference material kept outside the procedure. Progressive disclosure is a presentation and sequencing principle, not a standardized requirement, and deferring content does not change which information a product must be supplied with.
information design · technical communication · chunking · Reading behavior · Findability
Definition and examples
Cognition and analysis methods
Mental model
German: mentales Modell
In cognitive science and usability, a mental model is an internal representation of how something works — a system, a situation or a relationship — that a person uses to understand, predict and decide, for example a user's belief about how a machine or software behaves.
Cognitive science · Technical documentation
Definition and examplesFive whys
German: 5-Why-Methode
In quality management, the five whys is a questioning technique that asks “why?” repeatedly — typically about five times — to trace a problem from its symptom to an underlying cause; it was developed at Toyota and described by Taiichi Ohno as part of the Toyota Production System.
Thinking models · Problem solving · Engineering
Definition and examples
1 · Documentation models
Every page is page one
In technical communication, Every Page is Page One (EPPO) is a model for topic-based writing, set out by Mark Baker in the book of the same name (XML Press, 2013), in which every topic is designed to work as a reader's first page. It assumes that readers arrive from search, links, or in-product help rather than from a table of contents, so each topic has to carry its own context and purpose instead of relying on a preceding chapter. Baker describes seven characteristics of an EPPO topic: it is self-contained, has a specific and limited purpose, conforms to a type, establishes its context, assumes the reader is qualified, stays on one level, and links richly. EPPO is an authoring and information-architecture model, not a markup standard or a conformance scheme.
documentation models · topic-based authoring · information architecture · findability · technical communication
Definition and examplesStructured authoring
German: strukturiertes Schreiben
In technical communication, structured authoring is a way of writing in which content is created as discrete information units that follow a formally defined content model — a schema, document type definition, or specification — rather than as free-form pages shaped by a word processor. Meaning is marked up explicitly (a warning is tagged as a warning, a step as a step), while typography, pagination, and layout are applied later by a publishing process. Because the markup is validated against the model, the same source can be checked automatically, reused across deliverables, and rendered to print, HTML, or machine-readable formats. Structured authoring is one of the six documentation models described in the encyclopedia subject area Technical documentation models and is usually combined with the others rather than used alone.
structured authoring · content model · XML · single-sourcing · documentation models
Definition and examples- Working term
Technical documentation model
In technical communication, a technical documentation model is a set of principles for dividing, organizing and expressing technical content so that readers can find and use it. A model answers questions such as how large a unit of content should be, what each unit is about, how units connect, how content is marked up and how much prose a reader needs. The term is an umbrella label rather than a standardized one: no standard defines "technical documentation model", and the individual models come from technical communication literature and from publishing practice. Models are design principles, not deliverables, and they say nothing by themselves about whether a documentation set meets a legal or contractual requirement.
technical documentation · documentation models · information design · structured authoring · topic-based
Definition and examples Minimalism (technical communication)
German: Minimalismus
In technical communication, minimalism is a documentation model that shapes instructional content around what users actually do with a product, rather than around a complete description of its features. It originates in John M. Carroll's research on learning with computer systems, published as The Nurnberg Funnel (MIT Press, 1990), and was condensed by Hans van der Meij and Carroll into four design principles: choose an action-oriented approach, anchor the tool in the task domain, support error recognition and recovery, and support reading to do, study, and locate. Minimalism is therefore a selection and design discipline, not a rule to write less: content is chosen for its contribution to the user's task and to recovery from mistakes, and supporting material is kept reachable rather than deleted. It is a method from documentation theory, not a standard, and it does not override content that regulations or standards require.
documentation models · technical communication · information design · Reading behavior · technical documentation
Definition and examplesSemantic documentation
German: semantische Dokumentation
In technical communication, semantic documentation is documentation whose meaning is represented in machine-readable form — by semantic markup within the content and by metadata about the content that refers to controlled vocabularies, taxonomies or ontologies — so that software can select, filter, link, deliver and check the information by what it is about, not only by where it stands in a document.
Documentation models · Metadata · Semantics
Definition and examplesTask-based documentation
German: aufgabenorientierte Dokumentation
In technical communication, task-based documentation is documentation whose content is selected, organized and named according to the tasks users perform to reach their goals with a product, as identified by task analysis, rather than according to the product’s features, components or menus.
Documentation models · Tasks · Minimalism
Definition and examples
3 · Tasks and minimalism
Cognitive task analysis (CTA)
German: kognitive Aufgabenanalyse
In human factors, cognitive task analysis (CTA) is a family of methods for identifying the knowledge, cues, judgments, decisions and typical errors behind a task, especially expert tasks whose thinking cannot be observed directly, using interviews, observation and the analysis of incidents.
Technical documentation · Task analysis · Human factors
Definition and examplesHierarchical task analysis (HTA)
German: hierarchische Aufgabenanalyse
In human factors, hierarchical task analysis (HTA) describes a task as a hierarchy of goals, subgoals and operations, linked by plans that state when and in which order the subordinate operations are carried out; it was developed by John Annett and Keith Duncan in the late 1960s.
Technical documentation · Task analysis · Human factors
Definition and examplesTarget audience analysis
IEC/IEEE 82079-1German: Zielgruppenanalyse
In technical communication, target audience analysis identifies who will use the information for a product — their tasks and goals, skills and qualifications, terminology, tools, language and working environment — so that the information for use can be made usable and relevant for each target audience.
Technical documentation · Standards · Human factors
Definition and examplesSubject-matter expert (SME)
German: Fachexperte
In technical communication, a subject-matter expert (SME) is a person with specialist knowledge of a product, process or domain who supplies, explains and checks the facts that technical writers turn into usable information.
Technical documentation · Human factors
Definition and examplesTeam task analysis (TTA)
German: Team-Aufgabenanalyse
In human factors and industrial-organizational psychology, team task analysis (TTA) identifies the parts of a task or job that cannot be done by one person alone — handovers, shared decisions, coordination and communication between roles — and the extent to which a task depends on teamwork.
Technical documentation · Task analysis · Human factors
Definition and examplesAction orientation
German: Handlungsorientierung
In technical communication, action orientation is the principle of minimalist and task-based documentation that lets users act on real tasks as early as possible and organizes the information around the actions they take and the results those actions produce, rather than around the product’s features or a body of knowledge to be studied first.
Minimalism · Documentation models · Tasks
Definition and examplesControlled language
German: kontrollierte Sprache
In technical communication, a controlled language is a restricted form of a natural language that limits vocabulary, word meanings, grammar and style through explicit rules, in order to make texts clearer and more consistent for their readers and easier to translate or to process by machine.
Writing rules · Minimalism · Translation
Definition and examplesReading to do
In research on workplace and technical reading, reading to do is reading in order to extract information for immediate action, such as performing a task while consulting instructions, as distinguished from reading to learn, which aims at retaining information for later use, and from reading to locate a specific piece of information.
Minimalism · Tasks · Reading behavior
Definition and examplesSimplified Technical English
ASD-STE100Simplified Technical English (STE), specified in ASD-STE100, is a controlled language for technical documentation in English, owned by ASD (the Aerospace, Security and Defence Industries Association of Europe) and maintained by its Simplified Technical English Maintenance Group; it combines writing rules with a dictionary of approved words, each with one meaning, and originated as AECMA Simplified English for aircraft maintenance documentation.
Writing rules · Standards · Translation
Definition and examplesTask analysis
German: Aufgabenanalyse
In technical communication, usability and human factors, task analysis is the systematic study of how people achieve goals with a product or system — who the users are, which goals they pursue, which tasks and subtasks they perform, under what conditions, with which decisions and handovers — where a task, in the sense of ISO 9241-11:2018, is a set of activities undertaken to achieve a specific goal and the activities can be physical, perceptual and cognitive.
Task analysis · Tasks · Usability
Definition and examples
4 · Structure and semantics
Content model
German: Inhaltsmodell
In structured authoring, a content model is the set of rules that specifies which child elements, text and attributes an element may contain, in what order and how often; it is declared in a document type definition, an XML Schema or a RELAX NG schema and is enforced when documents are validated.
Structured authoring · Markup · Standards
Definition and examplesDocBook
DocBook 5.1DocBook is a general-purpose XML schema for technical and software documentation, especially books and articles, maintained by the OASIS DocBook Technical Committee; it began in 1991 as an SGML document type of HaL Computer Systems and O’Reilly & Associates and has been defined in RELAX NG with Schematron rules since version 5.0.
Structured authoring · Markup · Standards
Definition and examplesDocument-domain markup
In structured writing as described by Mark Baker, document-domain markup is markup that records the structures of a document — such as sections, titles, lists, tables, procedures and steps — independently of how they will be formatted in any medium, but without recording what the content is about.
Structured writing · Markup
Definition and examplesS1000D
S1000DGerman: S1000D
In technical communication, S1000D is an international specification for producing, managing, and publishing technical publications from a common source database. Content is written as data modules — self-contained information units with a structured identification code and status metadata, encoded in XML against the schemas issued with the specification — which are stored in the Common Source Database (CSDB) and assembled into publications, printed output, or interactive electronic technical publications. The specification was originated in the aerospace sector by the Aerospace, Security and Defence Industries Association of Europe (ASD) and is now produced jointly by ASD, the Aerospace Industries Association of America (AIA), and the ATA e-Business Program; its scope has grown beyond air vehicles to land and sea products and to non-equipment subjects. Projects do not implement the specification verbatim but record their choices as business rules, which are expressed in machine-checkable form through a business rules exchange (BREX) data module.
structured authoring · XML · modular content · content reuse · technical documentation
Definition and examplesSemantic markup
German: semantisches Markup
In structured authoring and web publishing, semantic markup is markup that names what a piece of content is or means — for example a parameter, a hazard, a part number, a command or a list — rather than how it should look, so that its presentation is decided separately and software can process the content by its meaning.
Markup · Semantics · Structured authoring
Definition and examplesStructured writing
In technical communication, structured writing is the practice of writing content to explicit, defined structures — patterns for what a given kind of content contains and in what order — whether those structures are followed by convention and templates or recorded and enforced in markup.
Structured writing · Information design
Definition and examplesSubject-domain markup
In structured writing as described by Mark Baker, subject-domain markup is markup that records the subject matter of the content — for a recipe, its ingredients, quantities and preparation time; for a machine, its parameters, components or error codes — rather than the document structures or the formatting in which the content will be presented.
Structured writing · Markup · Semantics
Definition and examples
5 · Content lifecycle and AI
- Working term
AI-derived content
In technical communication, AI-derived content is text, images or data that an AI model produces from existing content for a particular purpose — for example a draft, a summary, a machine translation or a generated answer — as distinct from the released source content it was derived from.
Content lifecycle · AI · Technical documentation
Definition and examples - Working term
Answer provenance
In AI functions that answer from documentation, answer provenance is the recorded trace from a generated answer back to the source units it was built from, their versions, and the model, configuration and time that produced the answer.
Content lifecycle · AI · Technical documentation
Definition and examples Content Credentials (C2PA)
C2PA specificationContent Credentials are the provenance records defined by the technical specification of the Coalition for Content Provenance and Authenticity (C2PA): a digitally signed manifest of assertions about an asset — such as how it was created and edited, including with AI — bound to the asset so that tampering can be detected.
Content lifecycle · AI · Standards
Definition and examplesContent lifecycle
In technical communication and content management, the content lifecycle is the sequence of stages a piece of content passes through from planning to retirement — typically planning, creation, review, approval, management, translation, publication, use, maintenance and retirement — together with the roles, rules and records that govern each transition.
Content lifecycle · Technical documentation
Definition and examplesContent operations (ContentOps)
Content operations (ContentOps) is the set of people, processes, standards and tools with which an organization plans, produces, reviews, translates, publishes, maintains and measures content at scale, treating content production as an operational discipline rather than as individual projects.
Content lifecycle · Technical documentation
Definition and examplesContent provenance
Content provenance is information about the origin and history of a piece of content: who or what created it, from which sources, with which tools — including AI models — and how and by whom it was changed, reviewed and released over time.
Content lifecycle · AI · Technical documentation
Definition and examplesContent retirement
In content management, content retirement is the controlled withdrawal of content that no longer applies from use and delivery — including from search, portals and the retrieval indexes of AI functions — while the content is kept archived and traceable for as long as records must be retained.
Content lifecycle · AI · Technical documentation
Definition and examples- Working term
Content risk classification
In technical communication, content risk classification is the division of content into classes by the consequence of an error — for example safety-related and legally required information, operating information and marketing text — so that the depth of review, the qualification of the reviewer and the strength of the release follow the risk.
Content lifecycle · AI · Technical documentation
Definition and examples Curated corpus
In AI functions that answer from documentation, a curated corpus is a controlled collection of released, reviewed content that the function may retrieve from or be tuned on, with defined rules for what enters and leaves it, as opposed to an uncurated collection of whatever content is available.
Content lifecycle · AI · Technical documentation
Definition and examplesReview gate
In content and development processes, a review gate is a defined point at which content or a work product may only move on to the next stage after a named, qualified person has reviewed it against stated criteria and recorded a decision to release, return or stop it.
Content lifecycle · AI · Technical documentation
Definition and examples
6 · Translation and terminology
Automated style checking
In technical communication, automated style checking is the use of software to check texts against a style guide, grammar rules, approved terminology and the rules of a controlled language, either rule-based or with AI models, and to report or suggest corrections to the author.
Translation and terminology · AI · Technical documentation
Definition and examplesMachine translation post-editing (MTPE)
ISO 18587:2017German: Post-Editing maschineller Übersetzungen
Machine translation post-editing (MTPE) is the editing and correcting of machine translation output by a qualified post-editor, comparing it with the source text, so that the target text reaches an agreed quality; ISO 18587:2017 sets requirements for full post-editing, which aims at a result comparable to human translation.
Translation and terminology · AI · Standards
Definition and examplesTerminology management
ISO 704:2022; ISO 30042:2019German: Terminologiemanagement
Terminology management is the identification, definition, recording and maintenance of the concepts and terms of a subject field, together with their equivalents in other languages, their usage status (preferred, admitted, deprecated) and related data, usually in a termbase that authors, translators and software can use.
Translation and terminology · Standards · Technical documentation
Definition and examplesTranslation memory
TMX 1.4bGerman: Translation Memory
A translation memory is a database of aligned source and target segments from earlier translations, which computer-assisted translation tools search to offer stored translations of identical or similar segments (exact and fuzzy matches) for reuse; TMX (Translation Memory eXchange) is the XML format for exchanging such data between tools.
Translation and terminology · Standards · Technical documentation
Definition and examples
7 · Product information systems and data roles
System of record
German: Führendes System
In data management, a system of record is the system that is authoritative for a given data object or attribute: the place where its valid value is created or changed under control, so that every other system takes that value from it or reconciles against it.
Data management · Technical documentation
Definition and examplesGolden record
In master data management, a golden record is the consolidated, agreed version of one business object — a product, material, customer or supplier — built by matching and merging the records that several systems hold about it under defined survivorship rules.
Data management · Master data
Definition and examplesMaster data management (MDM)
German: Stammdatenmanagement
Master data management (MDM) is the discipline, with its processes, roles and systems, that keeps an organization’s shared master data — products, materials, customers, suppliers, locations — uniform, accurate and accountable across the systems that use it, and distributes it to them.
Data management · Master data
Definition and examplesData owner
In data governance, a data owner is the person, usually in the business, who is accountable for a data domain or data object: for its definition, its permitted uses, its quality targets and the decisions on access and change.
Data management · Data governance
Definition and examplesData steward
In data governance, a data steward is the person who looks after a set of data on behalf of its owner: maintaining definitions, business rules and metadata, monitoring data quality and resolving conflicts between systems and users.
Data management · Data governance
Definition and examplesData custodian
In data governance, a data custodian is the person or team responsible for the technical care of data — storage, security, backup and recovery, and implementing access rules — without deciding what the data means or who may use it.
Data management · Data governance
Definition and examplesSource system
German: Quellsystem
In data integration and data warehousing, a source system is the system from which data is extracted or received for a given data flow; seen from the receiving system, it is the upstream system.
Data management · System integration
Definition and examplesDownstream system
In data integration, a downstream system is a system that receives data from another system and uses or passes it on, so that changes in the upstream data affect it.
Data management · System integration
Definition and examplesDerived data
German: Abgeleitete Daten
Derived data is data produced from other data by calculation, aggregation, filtering, transformation or copying, so that its correctness depends on its inputs and on the process that produced it.
Data management · Technical documentation
Definition and examplesEnd-user computing (EUC)
In IT governance and risk management, end-user computing (EUC) means applications that business users build and run themselves outside governed IT systems — spreadsheets, macros, shared lists, small databases and automated flows — often without the testing, version control and access controls of governed systems.
Data management · Data governance
Definition and examplesSemantic model (BI)
In business intelligence, a semantic model is the layer between data sources and reports that defines tables, relationships, calculations (measures) and business names, so that dashboards and queries use the same definitions of each figure.
Data management · Data analytics
Definition and examplesETL and ELT
ETL (extract, transform, load) and ELT (extract, load, transform) are two patterns for moving data from source systems into a target: ETL transforms the data before loading it, ELT loads it first and transforms it inside the target system.
Data management · System integration
Definition and examplesData product
In data mesh, a data product is a dataset that a domain team offers to consumers as a product: with a named owner, documentation of its meaning and structure, quality commitments and an interface through which other teams and systems can find and use it.
Data management · Data governance
Definition and examplesData contract
A data contract is an agreement between a data producer and its consumers that defines the structure (schema), meaning, quality expectations, service levels and change rules of the data delivered, often written in a machine-readable form so it can be checked automatically.
Data management · System integration
Definition and examplesW3C PROV
W3C PROV-DMW3C PROV is the family of W3C specifications for representing provenance — information about the entities, activities and agents involved in producing a piece of data or a thing — published on April 30, 2013 as four Recommendations (PROV-DM, PROV-O, PROV-N, PROV-CONSTRAINTS) and eight Notes.
Standards · Data management · Ontology
Definition and examplesSystem of engagement
A system of engagement is a system through which people interact with an organization and its information — portals, apps, collaboration tools, chat and answer functions — as distinguished by Geoffrey Moore (AIIM, 2011) from the transaction-oriented systems of record behind them.
Data management · Technical documentation
Definition and examplesProduct information management (PIM)
German: Produktinformationsmanagement
Product information management (PIM) is the set of practices and systems that collect, enrich, translate and distribute the product information used in sales, marketing and commerce channels — descriptions, attributes, classifications, images and documents — to catalogs, shops, marketplaces and portals.
Data management · Master data · Technical documentation
Definition and examples
Definitions follow the cited standards and specifications. Where a source is a copyrighted publication, such as an ISO, IEC or EN standard, the definition is a close paraphrase, not a verbatim quotation, so as not to infringe copyright. We recommend reading the original publication. The sections “How it applies” are editorial commentary by AI TechDoc Knowledge and are not part of any standard.