Encyclopedia · Subject area

Technical documentation models

A technical documentation model is a set of principles for dividing, organizing and expressing technical content. Several models shape current practice. This subsection distinguishes six — topic-based documentation, task-based documentation, Every Page is Page One, semantic documentation, minimalism and structured authoring — describes each in a separate article and examines how they combine in a documentation system.

By knowledge.aitechdoc.world · Last reviewed October 1, 2026

Articles

Scope and terminology

The six models answer different questions. Topic-based documentation defines the unit of content, task-based documentation the selection of content, Every Page is Page One the independence of each page, semantic documentation the representation of meaning, minimalism the relationship between content and action, and structured authoring the technical form in which content is written. The models are therefore not alternatives; most documentation systems apply several of them at once.

The designations are established in technical communication but not standardized. Some refer to published works (Every Page is Page One, minimalism), some to families of standards (structured authoring), and some to general practices (task-based and semantic documentation).

Common characteristics

All six models depart from the book as the organizing principle of technical content. They place the reader’s purpose, the unit of content or the structure of information at the center, and they make documentation more amenable to reuse, automation and machine processing. None of them, on its own, determines whether documentation is correct or meets legal requirements for information for use.

Comparison

Comparison of the types of software development kit
Type	Question answered	Unit or focus	Origin	Typical implementation	Main limitation
Topic-based documentation	How is content divided?	The topic, typed and assembled by maps	Information Mapping, online help, DITA	DITA, help authoring tools, CCMS	Fragmentation without context and links
Task-based documentation	Which content is needed?	User tasks derived from task analysis	Usability research, software style guides	Task topics, goal-based navigation	Neglect of conceptual and reference needs
Every Page is Page One	Can each page stand on its own?	The page as the reader’s entry point	Mark Baker (2013)	Web documentation, knowledge bases	No formal enforcement; link maintenance
Semantic documentation	What is the content about?	Meaning in markup and metadata	Descriptive markup, semantic web, iiRDS	Metadata schemes, ontologies, delivery portals	Depends on shared vocabularies and consistent tagging
Minimalism	How does content support action?	Action, real tasks, error recovery	John M. Carroll (1990)	Quick starts, embedded help, procedures	Misread as cutting required content
Structured authoring	In what form is content written?	Content models and validation	GML, SGML (ISO 8879:1986), XML	DITA, DocBook, S1000D, XML editors	Modeling effort; structure does not ensure quality

How the domains interoperate

The six models operate at different levels of a documentation system, and their contributions build on each other. A typical combination can be described from the reader’s need to the technical form.

Task-based documentation and minimalism

Task analysis determines which content a documentation set contains; minimalism determines how that content supports action. Together they define procedures that start with a real goal, contain one action per step and include information on recognizing and correcting errors.

Topic-based documentation and Every Page is Page One

Topic-based documentation divides content into units; Every Page is Page One sets the criteria each unit must meet to be useful when reached directly. EPPO’s requirement that a topic establish its context addresses the main weakness of modularization, the loss of context.

Semantic documentation and Every Page is Page One

The context that an EPPO page states in its text can also be recorded as metadata: product, component, lifecycle phase, audience and information type. Semantic documentation thereby makes the context of each page available to delivery systems, which can then select pages for a situation and generate links along defined relations.

Structured authoring and the other models

Structured authoring provides the mechanisms that make the other models enforceable. Content models implement information types, required elements implement context and results, metadata attributes implement semantic classification, and maps implement the assembly of topics. Validation checks that each unit conforms to its type.

Semantic documentation and machine use

When content is typed, structured and semantically described, it can be processed by search engines, content delivery portals, digital twins and AI systems. Retrieval-augmented systems select passages by their metadata and structure; the quality of their answers depends on the quality of these descriptions.

Conditions for interoperation

Combining the models requires an information model that defines information types, metadata and relations; controlled vocabularies shared by authors and systems; and editorial rules that translate principles such as minimalism and EPPO into templates and checks. Where these conditions are missing, the models remain separate practices rather than parts of one system.

Context cards

Glossary terms

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: 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.
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.
Structured authoring: 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.
Information model: In information architecture, an information model is a technology-neutral model of concepts, relationships, rules and information requirements. It describes what information a domain needs and what it means, before any choice of database, format or protocol.
Metadata: In information management, metadata is data that describes other data or resources, such as their meaning, origin, format, units, owner, time stamp, version or classification, so that they can be found, understood, managed and used correctly.
DITA (Darwin Information Typing Architecture): DITA (Darwin Information Typing Architecture) is an OASIS XML standard for creating, managing and publishing topic-based content. Content is authored as typed topics, organized and reused through maps, and extended through specialization. DITA 1.3 is the version approved by OASIS in December 2015.
DITA information typing: In DITA, information typing is the practice of writing each topic as one type of information — such as a concept, a task or a reference — with a content model designed for that type. The information type determines which elements a topic may contain and in what order.
iiRDS Topic: In iiRDS (intelligent information Request and Delivery Standard), a Topic is an information unit that deals with a single subject and can be understood on its own — for example one task, one concept or one reference table.
Information for use: In machine safety, information for use is the safety-related information supplied to users of a machine, including instructions, warnings, markings and training requirements. Under ISO 12100 it is the third step of risk reduction and informs users about residual risks that design and safeguarding could not remove.