Glossary of technical communication

A master list of industry-specific technical terms, acronyms, and professional definitions

A

absolute path
The full address of a file or directory starting from the root of the file system, specifying every subfolder needed to reach the target resource exactly and without ambiguity.

accessibility (a11y)
The practice of making documentation usable by as many people as possible, including those with visual, auditory, or cognitive disabilities.

accessibility budget
Configuration thresholds that allow for selective legacy page exclusions or policy tolerances during automated compliance runs.

active voice
A sentence structure following the subject-verb-object (SVO) pattern to create direct and actionable instructions.

admonition
A visual element, such as a note, tip, or warning, used to draw a reader's attention to specific information outside the main flow of text.

agile documentation
An iterative approach to content creation that aligns with the software's development sprints and cycles.

AI-generated content (AIGC)
Text, images, or other media created by large language models and generative tools to assist in the documentation process.

AI knowledge management
Using AI to collect, organize, and retrieve information. It replaces old keyword searches and manual folder sorting with smart tools such as natural language processing and semantic search.

AI safety guardrails
Programmatic boundaries, input/output filters, and system prompts designed to prevent large language models from generating harmful or restricted content.

alternative text or alt txt (alt-txt)
A descriptive attribute added to images to ensure information is accessible to users with visual impairments or when images fail to load.

American Standard Code for Information Interchange (ASCII)
A standard character encoding scheme used for representing text in computers and other devices that use Latin alphabets.

anchor
A specific target point within a document that allows a hyperlink to jump directly to a particular section rather than the top of the page.

annotation
A note or comment added to a text, diagram, or code snippet to provide extra context or explanation for the reader.

API documentation
Comprehensive instructions for using an application programming interface, including tutorials, code examples, and best practices, to help developers integrate and interact with a specific software service or platform.

API endpoint
A specific URL where an API receives requests and sends responses to enable communication between different software applications.

API explorer or sandbox
An interactive portal feature that allows developers to test API calls and view live responses directly in a browser.

API reference
A technical manual providing detailed descriptions of specific endpoints, parameters, and return types, usually generated from source code to serve as a precise dictionary for developers during integration.

API reference generation
The pipeline of extracting inline comment structures directly from codebases to produce technical documentation references automatically.

appendix
A section at the end of a document containing supplementary information that is too detailed or specialized for the main body.

application lifecycle management (ALM)
The integrated system of people, processes, and tools that manage a software application from its initial conception through retirement.

application programming interface (API)
A set of rules and protocols that allow different software applications to communicate and exchange data with each other.

artificial intelligence (AI)
Technology that enables computers to perform tasks typically requiring human intelligence, such as language processing and pattern recognition.

ASCII or UTF-8
Plain-text encoding standards that ensure documentation is transparent, portable, and machine-readable.

AsciiDoc
AsciiDoc is a semantic markup language similar to Markdown but with standardized syntax and native support for tables, cross-references, and PDFs.

Association of Teachers of Technical Writing (ATTW)
A professional organization focused on the pedagogy and research of technical and professional communication in academic settings.

AsyncAPI
An open-source specification used for documenting event-driven architectures, such as webhooks and message-based systems.

atomic commits
The practice of making small, independent code or documentation changes that fulfill a single task, ensuring that version control history is clear, manageable, and easy to revert.

atomic content
Documentation written in small, self-contained units or "atoms" to improve findability and AI retrieval efficiency.

audience analysis
The process of researching and identifying the specific needs, skills, and goals of readers to ensure technical content is appropriate for their level of expertise and professional requirements.

audit trail
A step-by-step chronological record that provides evidence of the history and sequence of activities related to a specific document, transaction, or administrative change within a secure software system.

Australian Society for Technical Communication (ASTC)
A professional body representing technical communicators in Australia, providing resources and networking for industry professionals.

authentication schemes
Methods used to verify user identity for API access, including API keys, bearer tokens, and OAuth2.

automated accessibility scans
Programmatic evaluations executed within a CI/CD build pipeline to check compiled HTML files for WCAG violations.

automation with a human touch (jidoka)
A principle from lean manufacturing that emphasizes intelligent automation, often applied to maintaining quality control within documentation workflows.

B

back matter
The supplementary sections located at the end of a book or manual, such as the index, glossary, and appendices.

back-translation
A quality control method where a translated document is translated back into the original language to verify accuracy and ensure that the core technical meaning remains completely intact.

backlog
A prioritized list of documentation tasks, including new features, maintenance, and technical debt, managed within an agile workflow.

backlog refinement
An ongoing agile process where technical writers and developers review, prioritize, and clarify upcoming tasks to ensure the team understands the requirements before starting a new work sprint.

bill of materials (BOM)
A comprehensive list of raw materials, assemblies, and parts required to manufacture a product, often documented in hardware manuals.

block element modifier (BEM)
A CSS naming convention used to create modular, reusable components in web development and documentation styling.

BM25 (Best Matching 25) algorithm
A highly efficient lexical ranking algorithm used by search engines to determine a document's relevance to a given search query.

boilerplate
Standardized text or code blocks that are reused across multiple documents or templates without significant changes.

bookmap
A master configuration file used to define the structural hierarchy, navigation, and compilation layout of individual documentation topics.

bounce rate
The percentage of users who leave a documentation site after viewing only one page.

breadcrumbs
A secondary navigation aid that shows a user's location within a site hierarchy, typically displayed as a horizontal trail of links.

business analyst (BA)
A professional who identifies business needs and determines solutions to business problems, often acting as a primary subject matter expert for writers.

business intelligence (BI)
The strategies and technologies used by enterprises for the data analysis of business information to support better decision-making.

business to business (B2B)
Commercial transactions or communications between two businesses, such as a software vendor and its corporate clients.

business to consumer (B2C)
The process of businesses selling products or providing information directly to individual consumers.

button labels
Specific, actionable verbs used on interface buttons to reduce click hesitation and guide user actions.

C

callout
A short string of text connected by a line to a specific part of an illustration or code block to highlight key features.

canonical link
HTML metadata specifying the primary address of a page to prevent search engine indexing penalties on duplicated or versioned pages.

Capability Maturity Model Integration (CMMI)
A process improvement training and appraisal program used to guide organizations in streamlining their development and documentation workflows.

Cascading Style Sheets (CSS)
A stylesheet language used to describe the presentation and formatting of a document written in HTML or XML.

categorical logic
A branch of logic dealing with propositions that describe relationships between classes of objects, often used in technical writing to create clear hierarchies and distinct, logical information classifications.

Certified Professional Technical Communicator (CPTC)
A professional certification offered by the STC to validate the foundational skills and knowledge of technical communicators. As of 2024, the STC has been dissolved and the CPTC program is no longer available.

chain-of-thought (CoT) prompting
A prompt engineering pattern that forces an AI model to generate intermediate logical reasoning steps before producing its final output.

changelog
A curated, chronological list of notable changes, bug fixes, and new features added to a software project, helping users understand what has evolved between different specific version releases.

choice paralysis
A state of indecision caused by presenting too many options to a user, which can be mitigated in documentation through progressive disclosure and clear, simplified navigation and layout paths.

chunking
The process of breaking down complex information into small, manageable pieces to improve a reader's ability to process and retain information.

clear, concise, complete, and correct (4Cs)
The foundational principles of technical writing that require content to be easy to understand, brief, accurate, and comprehensive.

click hesitation
The moment a user stops to wonder what an action will trigger due to ambiguous or unclear UI labeling.

cloze test
A usability test where words are removed from a passage to measure how well users can predict the content based on context.

code fence
Triple backticks used in markdown files to wrap code snippets and enable syntax highlighting for specific programming languages.

cognitive load theory
A psychological principle regarding the limited capacity of working memory, used in technical writing to simplify complex information.

Coleman-Liau index
A readability formula that calculates the grade level of a text based on characters per word and sentences per hundred words, focusing on objective linguistic data points and metrics.

command line interface (CLI)
A text-based interface used to interact with computer programs by typing commands instead of using a graphical user interface.

Compiled HTML Help (CHM)
A classic tripane desktop help window format that compresses standard HTML, CSS, and navigation files into a single binary.

compliance-driven documentation
Content created specifically to meet legal, regulatory, or safety standards, requiring high levels of accuracy and strict adherence to specific industry protocols to ensure organizational and user safety.

component content management system (CCMS)
A system that manages content at a granular component level rather than at a document level, facilitating high rates of content reuse.

computer-based training (CBT)
Interactive training programs delivered via computer, often featuring self-paced modules and assessments.

concept-task-reference (CTR) model
An information typing strategy that categorizes technical content into conceptual overviews, step-by-step procedures, and detailed reference data to improve clarity and facilitate efficient user search and learning.

conciseness reward (document length)
A BM25 search indexing behavior that favors short, focused articles over monolithic files when calculating query matches.

conditional processing or rendering
The automated technique of displaying or hiding specific portions of content based on variables such as user role, product version, or operating system within a single source publishing workflow.

conditional tag expressions
Using Boolean logic filters within source files to dictate which tag variations are included or excluded during compilation.

conditional text
Content within a source file that is flagged to be included or excluded during the build process based on specific target outputs.

confirmation dialog
A user interface component designed to prevent accidental data loss or high-risk actions by requiring user confirmation.

content audit
A systematic review and evaluation of all existing documentation to assess quality, accuracy, and relevance, identifying gaps, outdated information, or opportunities for consolidation and significant content improvement.

content automation
The use of software systems and scripts to automatically generate, update, format, or publish content without manual human intervention.

content debt (technical debt)
The backlog of missing, outdated, or poorly structured documentation that requires future effort to resolve.

content design (CD)
The practice of using data and user research to design content that meets specific user needs in a simple, accessible way.

content engineering
The technical discipline of designing and managing the infrastructure, data models, and workflows required to deliver structured content across multiple platforms, devices, and diverse user-facing digital applications.

content gap analysis
The process of identifying topics, keywords, or formats that your target audience cares about but your website currently lacks or covers poorly compared to competitors.

content governance
A strategic framework for managing the lifecycle of content to ensure it remains accurate, consistent, and useful.

content journey
A map of the path a user takes from their initial search intent to the successful completion of a task.

content management (CM)
The systematic process of collecting, managing, and publishing information in any form or medium throughout its lifecycle.

content management system (CMS)
A software application used to create, manage, and modify digital content, typically using a database and a graphical user interface.

content migration
The process of moving documentation from legacy systems, such as word processors or wikis, to modern stacks like markdown and Git.

content optimization tool (COT)
Software used to analyze and improve content for search engine performance, readability, and consistency.

content prototyping
The use of low-fidelity wireframes or mockups to test if a proposed information hierarchy meets user needs.

content reference (conref)
A DITA mechanism used to pull a single source of content into multiple locations, ensuring that updates made to the original fragment are automatically reflected everywhere it appears.

content reuse
The practice of using existing content components across multiple documents or outputs to ensure consistency and reduce maintenance effort.

content rot
The state where documentation becomes inaccurate, redundant, or orphaned over time due to a lack of maintenance.

content strategy
The high-level planning and management of content as a business asset to ensure it meets both user and organizational goals.

context window
The limited amount of text or data that a large language model can process at one time in its working memory.

context-sensitive help
Help documentation that provides specific information based on the user's current location or state within a software application.

contextual anchors
The practice of using explicit nouns instead of relative pronouns (for example, writing "Configure authentication keys" rather than "Configure this") to ensure isolated content chunks retain meaning during AI retrieval.

continuous documentation
The practice of integrating documentation updates directly into the software development lifecycle, ensuring that manuals and help files evolve simultaneously with the code they are describing for users.

continuous integration and continuous deployment (CI/CD)
A methodology that automates the building, testing, and deployment of software or documentation to ensure frequent and reliable updates.

CONTRIBUTING
A documentation file that guides community members on how to submit code, report bugs, and follow project standards for a repository.

contribution velocity
A metric tracking the frequency of edits made to documentation channels by non-documentation staff or community members.

controlled language
A restricted version of a natural language used to limit vocabulary and grammar to reduce ambiguity and translation costs.

conversion rate
The percentage of users who take a desired action, such as clicking a link or completing a task, often used to measure documentation effectiveness and overall site success.

create, read, update, and delete (CRUD)
The four basic functions of persistent storage, frequently documented in API reference materials to describe endpoint capabilities.

cross-reference
A notation within a document that directs the reader to related information in another part of the same work or a different work.

CSS Paged Media Module
A W3C stylesheet standard defining print-specific rules (such as margins, breaks, headers, and page counters) to generate PDFs from HTML.

curse of knowledge
A cognitive bias where an expert unknowingly assumes that others have the background information necessary to understand a topic, often leading to overly complex or confusing technical documentation.

customer experience (CX)
The total perception a customer has of a brand based on all interactions, including the quality and helpfulness of its documentation.

D

Darwin Information Typing Architecture (DITA)
An XML-based open standard for authoring, producing, and delivering information as small, self-contained components called topics.

data parsing
The process of analyzing a raw string of data or code and converting it into a structured format that a software program can understand.

definition of done (DoD)
A shared checklist of requirements, including documentation, that must be met before a software feature is considered complete.

deliverable
Any tangible or intangible product resulting from a project, such as a user manual, API reference, or set of release notes.

deprecation
The process of marking a product feature or software element as obsolete to warn users that it will be removed in future versions.

deprecation policy
A formal plan for identifying legacy features and communicating when their documentation will be retired.

description list (DL)
An HTML or Markdown list format used to group terms with their corresponding descriptions, commonly used for glossaries or metadata.

descriptive links
Hyperlink text that clearly indicates the destination or purpose of the link, improving accessibility for screen readers and helping all users navigate documentation sets more efficiently and intuitively.

developer experience (DX)
The overall feeling and ease of use a developer encounters when interacting with a company's software, APIs, and technical documentation.

developer portal
A centralized web platform providing tools, documentation, and resources such as API keys and sandboxes that developers need to build, test, and manage integrations with a software service.

developer relations (DevRel)
A specialized professional role focused on building relationships between a software company and external developers, involving technical advocacy, community engagement, and the creation of helpful educational developer resources.

Diagrams as Code (DaC)
The methodology of creating diagrams using text-based scripts and version control, allowing technical writers to generate, update, and manage visual architectures just like they do with software code.

diff-ability
The ability for version control systems to show precise, line-by-line differences between two versions of a plain-text file.

digital asset management (DAM)
A system used to store, organize, and retrieve rich media files, such as screenshots, videos, and diagrams, used within documentation.

DITA map
A structural file used in DITA that organizes individual topics into a hierarchy, defining the sequence and relationship of content for specific outputs such as web pages or PDF files.

Docs as Code (DaC)
A philosophy of managing documentation using the same tools and workflows as software development, including Git, markdown, and automation.

docstrings
Structured comments embedded directly within source code that describe the purpose, parameters, and return values of functions, classes, or modules to facilitate automated documentation generation.

docstring contract
A standardized syntax model agreed upon by writers and developers to ensure code comments compile successfully.

document development life cycle (DDLC)
A structured process for creating documentation that includes phases for analysis, design, drafting, review, and publishing.

Document Object Model (DOM)
A programming interface for web documents that represents the page structure as a tree of objects, allowing scripts to change content and style.

Document Type Definition (DTD)
A set of markup declarations that define the structure and legal elements of an XML or SGML document.

documentation funnel
A model representing the user journey through documentation, starting from initial search discovery to high-level conceptual understanding and finally to specific technical task completion or successful product troubleshooting.

documentation lag
The period of time between a software feature release and the update of its corresponding documentation, which technical writers strive to minimize through agile collaboration and advanced automation.

documentation lifecycle
The continuous process through which content is planned, created, maintained, and eventually retired.

documentation observability
The practice of using analytics, feedback, and system logs to gain visibility into how documentation is used, allowing teams to measure impact and identify areas for content improvement.

documentation pipeline
A series of automated steps that trigger whenever you make a change to your documentation repository.

dogfooding
The practice of having internal staff use a product's documentation to verify its accuracy before it is released to customers.

domain-specific language (DSL)
A specialized programming or markup language designed for a particular application domain, such as SQL for databases, often used to create highly efficient and targeted technical documentation sets.

don't repeat yourself (DRY)
A software development principle aimed at reducing repetition of information by using content reuse and modularity.

draft
An early, non-final version of a document intended for internal review, technical validation, or further editing.

dwell time
The amount of time a user spends on a specific page, used as a metric to measure engagement or difficulty.

dynamic filtering (profiling)
Applying metadata attributes to XML elements to show or hide content variations dynamically during publishing.

E

edge cases
Unusual or extreme conditions that occur outside of typical operating parameters, requiring specialized documentation to help users troubleshoot rare problems and understand complex system behavior and software limits.

editorial review
The phase of the documentation process where a second writer or editor checks content for style, grammar, clarity, and brand consistency.

electronic learning (e-learning)
Instructional content and training delivered digitally, often through a learning management system or interactive web portal.

electronic publication (EPUB)
An open-standard e-book file format that provides reflowable content for various digital reading devices.

electronic software delivery (ESD)
The digital distribution of software and its associated documentation, replacing the need for physical media.

embedded documentation
Content integrated directly into the user interface or code, such as tooltips, error messages, or in-code comments.

empty state
The screen a user sees when a feature has no data yet, often used to provide instructional microcopy on how to get started.

end of life (EOL)
A product stage where a software or hardware version is no longer sold, supported, or updated by the manufacturer.

endpoint
A specific URL where an API receives requests about a resource, serving as the primary focus of API reference documentation.

end user license agreement (EULA)
A legal contract between a software producer and a user that specifies the terms of use for the application.

enterprise resource planning (ERP)
A type of software used by organizations to manage and integrate the core parts of their businesses, often requiring extensive technical documentation.

error message architecture
A systematic framework for designing consistent, helpful, and actionable error messages that guide users toward a resolution rather than simply stating that a technical failure has occurred.

exit page
The final page a user visits before leaving a documentation site, analyzed to determine if the user found the answer they needed or left due to content frustration.

expert's blind spot
The tendency for subject matter experts to omit "obvious" steps that are actually crucial for a beginner to understand a task.

exploded view
A visual representation showing physical hardware components separated but aligned to demonstrate how they fit together, often mapped directly to a BOM.

Extensible Markup Language (XML)
A flexible text format used to create structured documents that are both human-readable and machine-readable.

Extensible Stylesheet Language (XSL)
A language used for expressing stylesheets that define how XML documents should be rendered or transformed.

Extensible Stylesheet Language Formatting Objects (XSL-FO)
An XML-based markup language used to describe the visual layout of printed pages generated from XML data.

Extensible Stylesheet Language Transformations (XSLT)
A language used to transform an XML document into another format, such as HTML, plain text, or a different XML structure.

extraction architecture
The automated pipeline that transforms code-level comments (docstrings) into intermediate structured JSON or Markdown formats for final rendering.

evidence-based writing
The practice of using search analytics, support tickets, and user data to decide what documentation to create or update.

F

feature flags (toggle states)
Mechanisms used to deploy software code in a dormant state, requiring writers to employ progressive documentation strategies.

few-shot prompting
Providing an AI model with in-context, input-to-output examples to guide it in reproducing custom writing styles or strict output schemas.

F-pattern / Z-pattern
Common visual scanning patterns followed by users when reading digital content, which inform layout and information design.

findability
The ease with which a user can discover specific information within a documentation set using search engines, navigation menus, internal links, and a well-organized, logical content hierarchy.

first-occurrence rule
An editorial constraint that applies tooltip tags exclusively to the first instance of a matched term on a page to reduce visual noise.

Flesch-Kincaid (F-K) readability tests
Readability tests designed to determine the reading grade level of a text based on sentence and syllable counts.

free and open source software (FOSS)
Software that is distributed under terms that allow users to run, study, change, and distribute the software and its source code.

frequently asked questions (FAQ)
A collection of common user inquiries and their respective answers, often used as a quick-reference support tool.

friction points
Specific moments in a user’s interaction with documentation or software where they encounter difficulty, confusion, or delays, often identifying critical areas where technical content needs urgent improvement.

front-loading
The technique of placing the most important information, such as key terms or primary actions, at the beginning of sentences and paragraphs to improve scannability and reader comprehension.

frontmatter
The introductory sections of a document, or the metadata block at the top of a Markdown file used by static site generators.

functional group description (FGD)
A document or section that describes a specific set of software functions and how they interact within a larger system.

functional requirements document (FRD)
A formal document that defines the specific behaviors, features, and functions a software system must provide to meet user needs.

functional specification (FS)
A technical document providing detailed information on how a software component or feature will be implemented and behave.

G

garbage in, garbage out (GIGO)
A concept stating that the quality of output is determined by the quality of input, highlighting the need for accurate source data when generating automated technical documentation scripts.

general design specification (GDS)
An overview document that outlines the high-level architecture and design goals for a software project or documentation set.

Git
A distributed version control system used to track changes in documentation files and facilitate collaboration among writers and developers.

global variables
Placeholders used in documentation systems to represent values that appear in multiple places, such as product names, allowing for easy updates across an entire document set simultaneously.

Globalization and Localization Association (GALA)
An international non-profit organization that provides resources and standards for the translation and localization industry.

globalization, internationalization, localization, and translation (GILT)
A collective term for the activities required to prepare and deliver products and documentation for international markets.

glossary
An alphabetical list of specialized terms and their definitions used within a specific document or knowledge base.

granularity
The level of detail or the size of individual content components in a documentation system.

graphical user interface (GUI)
A visual way of interacting with a computer using items such as windows, icons, and menus, used in contrast to a text-based interface.

GraphQL
A query language for APIs that allows clients to request exactly the data they need, requiring specialized schema documentation.

Gunning fog index
A readability test that estimates the years of formal education needed to understand a piece of writing, based on average sentence length and the percentage of complex words.

H

hallucination
A phenomenon in which a large language model generates information that sounds plausible but is factually incorrect or fabricated.

hash-based message authentication code (HMAC)
A security mechanism used in webhooks to verify that a payload was sent by a trusted source and was not tampered with.

help authoring tool (HAT)
A specialized software application used to create, manage, and publish help systems and technical documentation in multiple formats.

heuristic evaluation (HE)
A usability inspection method where experts check an interface against a set of established design principles to identify potential user friction.

Hick’s law
A design principle stating that the time it takes for a user to make a decision increases with the number and complexity of choices.

hierarchy
The structural organization of information, using heading levels and nested navigation to signal the relationship between different topics.

high-contrast mode
An accessibility feature that uses a limited color palette with high contrast between text and background, helping users with visual impairments read digital documentation much more easily.

HowTo schema
A JSON-LD structured data schema used to mark up step-by-step instructions to enable search engine rich results.

human-computer interaction (HCI)
A multidisciplinary field of study focusing on the design of computer technology and the interaction between humans and digital systems.

human-in-the-loop
A workflow where humans supervise or refine the output of automated systems, such as AI-generated drafts, to ensure that technical documentation remains accurate, safe, and contextually appropriate.

hyperlink
A clickable reference or navigation element in a digital document that directs the user to another location, such as a webpage or file.

Hypertext Markup Language (HTML)
The standard markup language used to create the structure and content of web pages and online documentation.

Hypertext Transfer Protocol (HTTP)
The foundational protocol used for transmitting data across the web, defining how messages are formatted and sent between browsers and servers.

Hypertext Transfer Protocol Secure (HTTPS)
An extension of HTTP that uses encryption to provide secure communication over a computer network.

I

immutable versioning
A documentation strategy where published versions are never changed or overwritten; instead, new updates are released as distinct versions to ensure historical accuracy and reliable user references.

imperative mood
A grammatical mood used for instructions where the subject is understood to be "you," starting sentences with a verb (for example, "Select").

inclusive language
A writing practice that avoids biased or exclusionary words, ensuring that technical documentation is welcoming, respectful, and accessible to readers from diverse backgrounds and different physical abilities.

independent software vendor (ISV)
A company that specializes in making and selling software designed for mass or niche markets, rather than custom software for a single client.

index
An alphabetical list of keywords and topics with corresponding page numbers or links, typically found at the end of a long-form manual.

information and communication technology (ICT)
An umbrella term that includes any communication device or application, as well as the various services and patterns associated with them.

information architecture (IA)
The structural design of shared information environments, focusing on the organization, labeling, and navigation of content to improve findability.

information design
The practice of presenting information in a way that makes it efficient and effective for the user to understand and act upon.

information mapping
A methodology for identifying and categorizing discrete blocks of information based on their purpose, such as procedures or facts.

information technology (IT)
The use of computers, storage, networking, and other physical devices to create, process, store, and exchange all forms of electronic data.

information typing
A methodology that categorizes content into specific types, such as concepts, tasks, and references, to ensure consistency.

inheritance
The mechanism where a content component or data object acquires the properties or metadata of its parent element within a structured hierarchy.

in-line documentation
Helpful content or explanations located directly within a product's source code or user interface rather than in a separate manual.

inline markup (SVG)
The integration method where vector graphic XML code is placed directly inside the HTML Document Object Model (DOM), allowing dynamic CSS styling.

input moderation
A pre-processing security layer that intercepts and evaluates user prompts against classification rules before they reach an LLM.

installation lifecycle
The chronological organization of a hardware or software deployment project into distinct, verifiable milestones.

Institute of Electrical and Electronics Engineers (IEEE)
A professional association that develops international standards for many industries, including technical communication and software engineering.

instructional design
The systematic process of designing and delivering educational materials, applying learning theories to technical documentation to help users master complex skills and software tools through structured educational experiences.

instructor-led training (ILT)
The practice of training delivered by a facilitator, either in person or via a virtual classroom, often supported by technical manuals.

integrated development environment (IDE)
A software suite that provides comprehensive tools for software development, commonly used by technical writers for Docs as Code workflows.

intellectual property (IP)
A category of property that includes intangible creations of the human intellect, such as copyrights, trademarks, and patented processes.

interface definition language (IDL)
A language used to describe a software component's interface, allowing different programs to communicate regardless of the language they were written in.

internal engineering runbook (playbook)
A task-oriented document designed for high-stress incident response, providing step-by-step procedures for DevOps and SRE teams to resolve system failures.

internal linking
The practice of connecting related pages within a single documentation site, helping users discover relevant topics, navigate complex hierarchies, and understand the relationships between different technical concepts.

internationalization (I18n)
The process of designing a product or document so that it can be easily adapted to various languages and regions without engineering changes.

Internationalization Tag Set (ITS)
A set of elements and attributes used in XML and HTML to support the internationalization and localization of content.

Internet of Things (IoT)
A network of physical objects embedded with sensors and software that connect and exchange data with other devices over the internet.

isometric schematic
A technical drawing depicting three-dimensional items (such as hardware systems or IoT ecosystems) on a two-dimensional grid where depth is required.

iteration
The repetitive process of refining documentation through multiple versions and review cycles based on feedback and testing.

J

jargon
Specialized terminology used by a particular group or profession that may be difficult for outsiders to understand, often requiring simplified explanations in general-purpose user documentation for better clarity.

Java Development Kit (JDK)
A software development environment used for developing Java applications, which technical writers often need to document in developer portals.

Java Runtime Environment (JRE)
The set of software tools required to run Java applications, distinct from the tools required to develop them.

JavaScript Object Notation (JSON)
A lightweight, text-based data format used to store and transport data, frequently used for API responses and documentation metadata.

JSON Payload
A text-based representation of structured data. It consists of key-value pairs and ordered lists.

just-in-time (JIT) learning
A delivery model where documentation or training is provided to the user at the exact moment they need it to complete a task.

justification
The typographical alignment of text so that the edges of a paragraph are straight along both the left and right margins.

K

kebab-case
A naming convention for files and URL slugs where words are written in lowercase and separated by hyphens (for example, user-setup.md).

kerning
The process of adjusting the spacing between individual characters in a font to achieve a visually pleasing and legible result.

key performance indicator (KPI)
A quantifiable measure used to evaluate the success of an organization or a specific activity, such as documentation helpfulness scores.

key reference (keyref)
A DITA mechanism that uses symbolic names to represent values or links, allowing writers to update a single key definition to change content globally across an entire document set.

knowledge base (KB)
A centralized online repository of information, such as articles, guides, and troubleshooting tips, designed for self-service user support.

knowledge base architecture
The structural design of a repository of information, including folder organization, taxonomy, and internal linking strategies that ensure users can easily navigate, find, and manage technical content effectively.

knowledge harvesting
The workflow of identifying high-traffic community contributions and converting them into official, stylized documentation.

knowledge management system (KMS)
Any kind of IT system that stores and retrieves knowledge to improve understanding, collaboration, and process alignment within an organization.

L

language service provider (LSP)
A company that offers a variety of translation, interpretation, and localization services to help businesses adapt their content for international markets.

large language model (LLM)
An artificial intelligence model, such as GPT-4, trained on massive datasets to assist in drafting, summarizing, and explaining content.

leading
The vertical distance between the baselines of successive lines of text, used to improve legibility and reduce reader eye strain.

lean-back or lean-forward intent
A behavioral model distinguishing between users who consume information for general knowledge and those who actively engage with documentation to solve a specific, immediate, and pressing technical problem.

learning content management system (LCMS)
A specialized platform used to create, store, and manage e-learning content, allowing multiple authors to collaborate on instructional materials.

learning management system (LMS)
A software application for the administration, documentation, tracking, and delivery of educational courses or training programs.

least astonishment design (LAD)
A design principle stating that a system or interface should behave in a way that users expect, minimizing confusion and surprises.

lightweight markup language
Human-readable, plain-text formats such as Markdown or AsciiDoc that are used to create structured documentation.

linguistic validation testing (LVT)
A process used to verify that translated content is linguistically accurate, culturally appropriate, and technically sound within the target region.

link checker
An automated tool that scans documentation files to identify broken or dead hyperlinks, ensuring that all internal and external connections remain functional and direct users to the correct resources.

link rot
The process by which hyperlinks point to web pages or resources that have become permanently unavailable over time, leading to a degraded user experience and broken documentation paths.

linting (prose linting)
The automated process of checking text against a style guide for errors in grammar, voice, and terminology using tools such as Vale.

locale
A set of parameters that defines a user's language, country, and any specific variant preferences that software and documentation use to provide culturally and linguistically appropriate content experiences.

localization (L10n)
The process of adapting a product, service, or document to a specific language, culture, and geographic market.

M

machine-readable content
Data or text structured in a way that computer programs can easily process and extract information, often using formats such as XML, JSON, or YAML for automated documentation workflows.

machine translation (MT)
The use of software and artificial intelligence to automatically translate text or speech from one natural language to another.

machine translation post-editing (MTPE)
A workflow where a human translator reviews and corrects machine-generated translations to ensure accuracy and professional quality.

Markdown (MD)
A lightweight markup language with plain-text formatting syntax that allows writers to easily create structured documents.

markup
A system of tags or codes inserted into a document to define its structure, layout, or how the text should be processed and displayed.

mean time to resolution (MTTR)
An SRE metric measuring the average duration required to resolve system issues, directly optimized by runbook clarity.

media independence architecture (MIA)
A design approach that separates content from its presentation, allowing information to be published across various formats without manual reformatting.

metadata
A set of data that provides information about other data, such as tags, author names, and descriptions used to organize and optimize content.

metadata indexing schema
The configuration within a database (specifically a vector database such as Pinecone, Weaviate, or Milvus) that determines which of those attributes are actually searchable or filterable.

metadata schema
A structured framework that defines how information about content is organized and categorized, allowing for improved searchability, filtering, and automated management of digital assets within a documentation system.

microcopy
Small snippets of text found in user interfaces, such as button labels, error messages, and tooltips, used to guide users.

Microsoft Writing Style Guide
A comprehensive guide that provides standards for writing technical documentation, focusing on terminology, tone, and formatting.

minimalist instruction
A documentation strategy that focuses on providing only the essential information needed for a user to complete a specific task.

minimum viable documentation
The smallest amount of documentation required to provide value to users and fulfill project goals, focusing on essential tasks and information while avoiding unnecessary or redundant content depth.

Modern Language Association (MLA)
A professional organization that provides a standard style for formatting papers and citing sources in academic and professional writing.

multi-channel compilation model
The system architecture of Help Authoring Tools where single-sourced XML or XHTML modules are processed into various outputs (for example, Web, PDF, CHM) by using target configurations.

Multipurpose Internet Mail Extensions (MIME)
An internet standard that extends the format of email to support attachments and text in character sets other than ASCII.

multi-channel publishing
The process of creating content once and distributing it across various platforms, such as web, PDF, and mobile apps, using automated tools to format the output for each medium.

N

natural language generation (NLG)
A subfield of artificial intelligence that focuses on converting structured data into human-readable text.

natural language processing (NLP)
A branch of artificial intelligence that enables computers to understand, interpret, and manipulate human language.

navigation
The system of links, menus, and visual cues that allows users to move through a documentation site and find specific information.

neural search
Search portal architectures relying on semantic vector spaces and intent similarity rather than literal string indexing.

nominalization
The process of turning a verb into a noun (for example, "verification" instead of "verify"), which is often avoided in plain language to improve clarity.

non-disclosure agreement (NDA)
A legal contract between parties that prohibits the sharing of confidential information, often signed by writers working on unreleased products.

O

objectives and key results (OKR)
A goal-setting framework used by teams to track measurable outcomes and align documentation efforts with broader company strategy.

observability
The practice of using data, analytics, and feedback loops to measure the effectiveness and health of a documentation site.

omnichannel delivery
A content strategy that provides a seamless and consistent user experience across all digital and physical touchpoints, ensuring that information is unified regardless of how the user accesses it.

one voice principle
An editorial standard ensuring that documentation sounds like it was written by a single person, maintaining consistent tone, style, and terminology across all content produced by a team.

ontology
A formal way of representing categories, properties, and relationships between concepts within a specific domain of knowledge.

OpenAPI Specification (OAS)
The industry-standard framework for describing RESTful APIs in a machine-readable format (formerly known as Swagger).

open source software (OSS)
Software with source code that is made available to the public, allowing anyone to inspect, modify, and enhance it.

optical character recognition (OCR)
Technology used to convert different types of documents, such as scanned paper or images, into editable and searchable digital data.

Organization for the Advancement of Structured Information Standards (OASIS)
A global non-profit consortium that drives the development and adoption of open standards for the information society, including DITA.

original equipment manufacturer (OEM)
A company that produces parts and equipment that may be marketed and sold by another manufacturer under a different brand name.

output sanitization
A post-processing evaluation phase that reviews AI-generated content (for example, checking for toxic language or PII leakage) before serving it to the user.

output transformation (OT)
The process of converting source files, typically XML or Markdown, into a final deliverable format such as PDF, HTML, or EPUB.

P

parser
A software component that takes sequential data, such as code or text, and breaks it down into smaller, structured parts.

P.O.U.R.
An acronym for the four principles of accessibility: perceivable, operable, understandable, and robust.

pagination
The process of dividing digital or printed content into discrete pages, or the numbering system used to help users navigate a long document.

pair writing
A collaborative session where a technical writer and a subject matter expert work together in real time to draft or refine content.

PARA method
An organizational model used to sort information by Projects, Areas, Resources, and Archives.

passive voice
A grammatical construction where the subject of a sentence is acted upon by the verb, often discouraged in technical writing for being less direct and harder to follow.

peer review
A collaborative process where colleagues examine each other’s documentation to identify errors, improve clarity, and ensure adherence to style guides before the final content is published for users.

personally identifiable information (PII)
Sensitive data that can identify an individual, which must be redacted or replaced with synthetic data in public documentation.

plain language (PL)
A writing standard that prioritizes simple sentence structures and common vocabulary to ensure the audience can understand content quickly.

pogo-sticking
A user behavior where individuals quickly bounce back and forth between a search results page and individual documentation articles, indicating that the content is not meeting their immediate needs.

Portable Document Format (PDF)
A file format that preserves the intended layout and formatting of a document regardless of the software or hardware used to view it.

Portable Network Graphics (PNG)
A raster-graphics file format that supports lossless data compression, commonly used in documentation for high-quality screenshots and diagrams.

progressive disclosure
A technique of shielding users from advanced or secondary information until it is explicitly requested or required for a task.

pre-installation auditing
Environmental, electrical, and network prerequisite evaluations performed before system setup begins.

preface
An introductory section at the beginning of a manual that explains the document's purpose, scope, and intended audience.

product experience (PX)
The total perception a user has of a product based on their interactions with the interface, functionality, and embedded help content.

progressive documentation
The practice of restricting or revealing technical content dynamically to align with progressive software rollouts or beta cohorts.

Project Management Professional (PMP)
An internationally recognized professional designation for individuals who lead and direct complex projects and teams.

prompt engineering
The practice of crafting precise inputs to large language models to generate high-quality, relevant documentation outputs.

proofreading
The final stage of the editorial process focused on identifying and correcting surface-level errors such as typos, punctuation, and formatting inconsistencies.

pull request (PR)
A collaborative method used in Git workflows where a writer submits documentation changes for peer review before they are merged into the main project.

Q

quality assurance (QA)
A systematic process used to determine if a product or document meets specified requirements and technical standards before release.

quality control (QC)
The set of activities and inspections used to evaluate the accuracy and usability of a completed documentation deliverable.

quick reference guide (QRG)
A concise document, usually one or two pages, designed to help users perform frequent or critical tasks without reading a full manual.

quick start guide (QSG)
A focused instructional document that leads a user through the initial setup or basic configuration of a product.

R

RACI matrix
A responsibility assignment framework mapping who is Responsible, Accountable, Consulted, and Informed across different stages of a documentation project.

rapid application development (RAD)
An agile software development methodology that prioritizes rapid prototyping and quick feedback over long-term, rigid planning.

ReAct (Reasoning and Acting) pattern
A reasoning and acting prompt framework that combines chain-of-thought thinking with external action-tool executions (such as running link checkers or API validators).

readability
An objective measure of how easy a piece of writing is to read and comprehend based on sentence structure and word choice.

README
The foundational text file in a project repository that introduces the software, explains how to install it, and outlines its usage.

Really Simple Syndication (RSS)
A standardized web feed format that allows users and applications to receive automated updates from websites or documentation portals.

red-teaming
Structured, adversarial safety testing aimed at finding bypasses or vulnerabilities in AI guardrails.

relative path
A file address expressed in relation to the current working directory, making it easier to move entire documentation projects between different servers or environments without breaking internal links.

release notes
A technical document distributed with a software update that summarizes new features, bug fixes, and known issues.

rendering
An automated process of generating a visual image or formatted webpage from a raw data file or markup language.

Representational State Transfer (REST)
An architectural style for designing networked applications, commonly used to build APIs that technical writers must document.

request for proposal (RFP)
A formal document that outlines project requirements and invites vendors to submit bids to provide a specific product or service.

retrieval-augmented generation (RAG)
A system that retrieves relevant snippets of documentation to provide context to an AI model, ensuring more accurate and grounded answers.

reStructuredText
A lightweight markup language used primarily in the Python community for technical documentation and creating structured web content.

return on investment (ROI)
A performance measure used to evaluate the financial efficiency of an investment, such as how documentation reduces support costs.

revision history
A log within a document or repository that tracks changes over time, including dates, authors, and descriptions of what was modified.

Rich Text Format (RTF)
A document file format developed for cross-platform document exchange that preserves basic formatting and font styles.

role-based access control (RBAC)
A method of restricting system or document access based on the specific roles assigned to individual users within an organization.

ROT data
An acronym in IT and data management that stands for Redundant, Obsolete, and Trivial information stored across enterprise systems.

runbook
A comprehensive, step-by-step guide used by IT and operations teams to manage infrastructure, applications, and services.

runbook drift
The divergence that occurs when system infrastructure is modified but its associated runbook is not updated accordingly.

S

sanity check
A quick, high-level test performed on a document or build to ensure it functions as expected and is ready for more thorough review or testing.

Scalable Vector Graphics (SVG)
An XML-based vector image format that can be scaled to any size without losing quality, making it ideal for responsive documentation diagrams.

scannability
The quality of content that allows readers to quickly find relevant information using headings, lists, and visual cues without having to read every word of the technical text.

scannability patterns
Predictable visual paths (such as the F-pattern) that readers follow when skimming content. Technical writers can leverage these natural behaviors to strategically place critical information where distracted users are most likely to see it.

scent of information
The visual and textual cues that suggest to a user whether a specific link or path will lead them to the information they seek.

schema
A formal description of the structure, data types, and constraints allowed within a specific data format, such as XML or JSON.

schema markup
Code added to a website's HTML to explicitly label content. It uses Schema.org vocabulary to help search engines and AI understand web pages, enabling rich search results and accurate AI citations.

scope
The defined boundaries of a documentation project, specifying what information is included and what is intentionally left out to meet user needs.

screen reader
Assistive software that converts digital text and interface elements into synthesized speech or Braille for users with visual impairments.

search engine optimization (SEO)
The practice of structuring and tagging content to improve its visibility and ranking in search engine results.

search relevance
The measure of how accurately a search engine matches a user's query with the most helpful, contextual results in a knowledge base.

Section 508
A US federal law requiring that all electronic and information technology used by the government be accessible to people with disabilities.

semantic chunking
Structuring and dividing technical pages into self-contained, conceptual units to optimize ingestion for AI search vectors.

semantic clustering
Grouping user queries of varying phrasings based on conceptual similarity to isolate missing documentation topics.

semantic hierarchy
The logical organization of content using levels of importance, typically represented by headings and subheadings, to help both users and search engines understand the structure of an article.

semantic markup
The use of HTML tags or XML elements that clearly describe the meaning and structure of the content rather than just its appearance.

semantic search
A data searching technique that uses intent and context to understand the meaning behind a query, delivering more accurate results than traditional keyword matching.

semantic tags
HTML or XML elements that clearly describe the meaning of the content they contain, helping search engines and assistive technologies better understand and process the documentation's underlying structure.

semantic versioning (SemVer)
A formal software versioning specification using a MAJOR.MINOR.PATCH naming convention to signal breaking, feature, or patch releases.

semantic wrapper pattern
An accessibility-focused markup structure (such as pairing role="img" with aria-labelledby) that ensures vector graphics are correctly parsed by assistive technologies.

sentence architecture
The deliberate arrangement of words and phrases within a sentence to ensure maximum clarity, proper emphasis, and easy comprehension for readers who may be scanning the documentation quickly.

sentiment widgets
Visual components embedded on websites or dashboards that measure, display, and analyze the "mood" or emotional tone behind data.

sequence diagram
A visual representation showing how different system components or actors interact over time, illustrating the chronological order of messages and actions within a specific technical process or workflow.

service level agreement (SLA)
A formal contract between a service provider and a user that specifies the expected level of service, uptime, and support response times.

seven Cs of communication
A framework used to ensure documentation is clear, concise, concrete, correct, coherent, complete, and courteous.

shadow docs
Technical knowledge that remains siloed within unstructured environments (such as chat channels or unindexed local wikis).

shift-left
A strategy of involving technical writers earlier in the software development life cycle, such as during the design and prototyping phases.

sidebar hierarchy
The organized navigation menu on a documentation site that defines the relationship and order of different categories and articles.

signal-to-noise ratio
The balance of critical information (signal) to filler words, redundant formatting, or irrelevant details (noise) in a document.

single sourcing
A documentation methodology that allows a single set of source files to be published in multiple output formats or versions.

single source of truth
The practice of maintaining a central, authoritative version of content to prevent synchronization issues across different platforms.

slug
The part of a URL that identifies a specific page in a human-readable format, usually derived from the page's title.

smoke testing (post-installation)
A brief execution cycle or self-test performed to verify that a system is minimally operational before final handoff.

snippet or partial
A small, reusable file containing text or code that is "included" or referenced in multiple larger documents to ensure consistency.

Society for Technical Communication (STC)
The largest professional association dedicated to the advancement of the field of technical communication and its practitioners. As of 2024, the STC has been dissolved.

software as a service (SaaS)
A software delivery model where applications are hosted by a provider and accessed by users over the internet, requiring specialized web-based documentation.

software development kit (SDK)
A collection of software tools, libraries, and documentation used by developers to create applications for a specific platform or service.

software development life cycle (SDLC)
The structured process used by engineering teams to design, develop, test, and deploy high-quality software.

spec-driven development
A methodology where documentation, specifically API specifications, is written before the code, serving as a blueprint for developers and ensuring that the final product matches the intended design.

special interest group (SIG)
A community within a larger professional organization that focuses on a specific technical area, industry, or professional niche.

specialty rule (keyword rarity)
A ranking parameter in the BM25 search algorithm that assigns higher score weights to rare technical keywords than common terms.

staging environment
A private, pre-production server where documentation and software are tested and reviewed in a realistic setting to identify and fix issues before being released to the live audience.

stale content
Documentation that is no longer accurate or relevant because the product or technology it describes has changed, necessitating regular audits to update, archive, or delete outdated information.

Standard Generalized Markup Language (SGML)
The legacy ISO standard for defining generalized markup languages, serving as the ancestor to both HTML and XML.

statement of work (SOW)
A legal document that defines the specific tasks, deliverables, and timelines for a documentation or consulting project.

standard operating procedure (SOP)
A set of detailed, step-by-step instructions designed to help employees carry out complex routine operations consistently.

static site generator (SSG)
An engine, such as Docusaurus or MkDocs, that transforms plain-text files into high-performance, searchable documentation websites.

story pointing
An estimation technique used in agile workflows to measure the complexity and research depth of a documentation task.

string
A technical term for a sequence of characters in code, often managed in a centralized glossary for user interface text.

structural layering
The organization of a technical illustration into distinct, labeled vector layers (for example, annotations, foreground, background guides) to ensure future editability.

Structured Query Language (SQL)
A standard programming language used specifically for managing and manipulating data held in relational databases.

structured writing
A method of authoring where content is created according to a rigid, predefined schema to ensure consistency and facilitate automation.

style guide
A set of standards for the writing, design, and formatting of documents to ensure a consistent "one voice" across an organization.

style guide as code
The practice of treating editorial rules and formatting standards as programmatic requirements, using automated linting tools to enforce consistent writing styles across large, collaborative documentation projects.

subject matter expert (SME)
An individual with deep technical knowledge of a specific product or process who provides information and validation to technical writers.

subject-verb-object (SVO) format
A simple sentence structure that identifies the actor, action, and recipient, widely recommended in technical writing to improve readability and reduce ambiguity for global user audiences.

support deflection
A metric measuring the reduction in support tickets achieved when users find answers independently in the documentation.

syntax highlighting
A feature of text editors and documentation sites that displays code in different colors and fonts based on its structural meaning, making it much easier for developers to read.

T

table of contents (TOC)
A navigational aid listing the major sections and page numbers of a document to provide an overview of the content structure.

tactical technical communication (TTC)
Decoupled, bottom-up knowledge-sharing practices (for example, wikis and community forums) that prioritize rapid, decentralized problem-solving over centralized governance.

tactical writing
The functional side of technical writing that delivers immediate utility through concise text, UI cues, and straightforward workflows.

target audience (TA)
The specific group of users for whom a document is written, defined by their technical expertise and professional goals.

task-based testing
A usability research method where participants are asked to complete specific actions using documentation, helping writers identify where instructions are confusing, incomplete, or lead to user errors.

taxonomy
A system used to classify and organize information into a hierarchical structure to improve findability and site navigation.

TechArticle schema
A JSON-LD metadata format identifying a web page as an authoritative technical resource for search crawlers.

technical communication (TC)
The process of taking complex, specialized knowledge and making it accessible and actionable for a specific audience.

Technical Communication Body of Knowledge (TCBOK)
A repository of information and best practices maintained by the STC to define the professional competencies of the field. As of 2024, the STC has been dissolved.

technical manual
A comprehensive document that provides detailed instructions on how to install, operate, or maintain a product.

technical review
A formal evaluation of documentation performed by subject matter experts to ensure that the facts, procedures, and code examples provided are completely accurate and reflect current software behavior.

technical SEO
Help portal optimizations aimed at improving search discoverability through crawlability, structured sitemaps, and semantic schema.

technical specification
A detailed document describing the requirements, design, and functional behavior of a system, serving as the primary reference for developers and writers during the software construction process.

technical translation
The process of converting technical documentation between languages while accurately preserving specialized terminology, complex instructions, and the intended meaning for a specific target global audience.

technical writing
The practice of creating clear, concise documentation that helps users complete tasks or understand complex technical systems.

template
A pre-formatted document or file that serves as a starting point for new content to ensure structural and visual consistency.

terminology management
The process of identifying, storing, and managing specialized terms to ensure they are used consistently across all documentation sets.

terminology tooltips
Hover-over user interface elements used to present jargon or acronym definitions without cluttering body text.

Text Encoding Initiative (TEI)
An international standard for the digital representation of texts, primarily used for data exchange in research and academic libraries.

think-aloud protocol
A usability testing method where a user verbalizes their thoughts and frustrations while attempting to follow a set of instructions.

three-dimensional (3D)
Visual content that includes width, height, and depth, often requiring specialized documentation for Computer-Aided Design (CAD), engineering, or gaming software.

three-level rule (navigation)
A design principle suggesting that users should be able to find any piece of information within three clicks, minimizing the complexity of the documentation hierarchy and improving findability.

ticket correlation
The process of linking documentation improvements to specific changes in the volume or type of support tickets received.

ticket deflection
A business metric measuring how effectively documentation prevents users from contacting customer support by providing them with the clear, self-service answers needed to solve technical problems independently.

time-to-hello (TTH)
A metric for developer experience measuring the time from user signup to their first successful API call.

toast notifications
Small, temporary pop-up messages in a user interface that provide confirmation of a successful action.

token
The basic unit of text, approximately four characters or three-quarters of a word, that a large language model processes.

tone of voice
The stylistic character of writing that conveys a specific personality or attitude, such as being professional, helpful, or direct.

tooltip density
A visual clarity metric tracking the ratio of compiled terminology tooltips to the total word count of a page.

tooltips
Small informational pop-ups that appear when a user hovers over or selects a specific interface element for contextual help.

topic-based authoring
A documentation methodology where content is written as modular, self-contained units rather than linear, book-style chapters.

transactional content
Automated messages, such as emails or banners, that are triggered by specific user actions such as password resets or account verification.

transformation engine
A transformation engine is a software system designed to map, convert, and route data or structures from one format to another.

translation management system (TMS)
A software platform used to automate and manage the translation and localization workflow for large document sets.

translation memory
A database storing previously translated text segments to reduce enterprise localization costs by avoiding re-translations.

troubleshooting
A systematic approach to identifying, analyzing, and resolving problems within a software or hardware system.

T-shaped professional
An individual who possesses deep expertise in one specific area, such as technical writing, while also having a broad, working knowledge of related fields like coding and design.

two-dimensional (2D)
Flat visual content, such as standard screenshots or flowcharts, that includes width and height but no depth.

typography
The art and technique of arranging type to make written language legible, readable, and visually appealing.

U

Unified Modeling Language (UML)
A standardized modeling language used to create visual representations of software systems, workflows, and actor interactions.

Unicode Transformation Format (UTF)
A character encoding standard that ensures text is consistently represented and displayed across different systems, languages, and platforms.

uniform resource identifier (URI)
A unique string of characters used to identify a logical or physical resource on a network, serving as the basis for both URLs and URNs.

uniform resource locator (URL)
A specific type of identifier that provides the web address of a resource and the protocol used to access it.

unstructured content
Information that does not follow a predefined data model or schema, making it more difficult to automate, reuse, or search compared to structured, topic-based technical documentation sets.

usability
The degree to which a document or product can be used by specific users to achieve their goals with effectiveness, efficiency, and satisfaction.

usability testing
The practice of observing real users as they interact with documentation to identify pain points, confusion, and areas where the content fails to support the user's intended goals.

use case
A description of a specific scenario in which a user interacts with a system to achieve a particular outcome, used to guide technical requirements.

user advocate
A role within a technical team dedicated to representing the end-user's needs and perspectives, ensuring that documentation and product features are designed with the user's success in mind.

user-centered design (UCD)
An iterative process where writers and designers focus on the end users and their needs at every stage of the documentation development life cycle.

user experience (UX)
The overall perception and emotional response a person has when interacting with a product, system, or documentation set.

user experience writing (UXW)
The practice of crafting the UI copy, such as labels, error messages, and tooltips, that guides users through a digital product.

user interface (UI)
The series of visual elements, including screens, pages, and interactive buttons, through which a user interacts with a software application.

user journey
The complete series of steps and interactions a user takes with a product and its documentation to achieve a specific goal, helping writers understand the context of information.

user need statement
A structured sentence used in content design to anchor an article in a specific user role, task, and goal.

user persona
A research-based representation of a target user group that helps writers tailor content to specific technical proficiency levels and goals.

V

Vale
Vale is a syntax-aware prose linter for Docs as Code. It ignores code blocks and uses highly extensible, customizable style rules.

validation
The process of evaluating a document or system during or at the end of the development process to determine whether it satisfies specified requirements.

validation loops
A repetitive process where documentation is drafted, reviewed, and tested multiple times to ensure it meets all technical requirements and user needs before being finalized for official publication.

variables
Placeholders used in documentation source files that are automatically replaced with specific values during the build process to handle repetitive or changing data.

vector graphics
Visual images created using mathematical formulas rather than pixels, allowing them to be scaled to any size without losing quality, making them ideal for high-resolution technical illustrations.

verification and validation (V&V)
The procedures used to ensure that documentation accurately reflects the product functionality and effectively meets the needs of the user.

version control system (VCS)
A software tool used to track changes to documentation files over time, allowing multiple contributors to collaborate via a centralized repository.

versioning
The practice of assigning unique identifiers to different iterations of a document to track historical changes and support specific software releases.

viewBox (protocol/attribute)
An SVG attribute that establishes a local coordinate system to allow vector graphics to scale fluidly without hardcoded pixel constraints.

visual communication
The practice of using diagrams, icons, and page layout to deliver information. By reducing reliance on dense text, it allows readers to quickly interpret and understand complex technical concepts.

visual hierarchy
The arrangement of design elements in a way that implies importance, guiding the user's eye to the most critical information first through the use of size and spacing.

voice user interface (VUI)
A technology that allows users to interact with a system through spoken commands and responses, requiring specialized conversational documentation.

W

wayfinding
The use of visual and structural cues, such as breadcrumbs and pagination, to help users understand their location within a documentation site.

web-based training (WBT)
Instructional content and training delivered digitally, often incorporating interactive modules, videos, and assessments for self-paced learning.

Web Content Accessibility Guidelines (WCAG)
The international standard for web accessibility that provides recommendations for making digital content more accessible to people with disabilities.

WebHelp / Responsive HTML5
A server-hosted package of standard HTML5, CSS, and search index files serving as the modern successor to desktop CHM help files.

webhook
An event-driven "reverse API" where a server automatically sends data to a client's URL when a specific trigger occurs.

WebSocket
A persistent communication protocol that provides full-duplex, real-time data exchange between a client and a server.

what you see is what you get (WYSIWYG)
An editor or interface that displays content during the authoring process in a form that closely resembles the final published output.

white paper
An authoritative report or guide that informs readers about a complex technical issue or presents a specific methodology for solving a problem.

whitespace
The areas of a page or screen left intentionally blank to separate elements, improve legibility, and reduce cognitive load for the reader.

widows and orphans (CSS)
Typographic styling controls used to prevent single, disconnected lines of text from stranding at page boundaries in PDF rendering.

WinHelp (.hlp)
A legacy, footnote-mapped, binary-based help format introduced by Microsoft.

who, what, where, when, and why (5Ws)
A research framework used by writers during the discovery phase to ensure all essential information is captured for a specific topic.

workflow
The sequence of industrial, administrative, or other processes through which a documentation task passes from initiation to completion.

workflow management system (WMS)
A software platform used to define, manage, and automate the various stages of a content creation or documentation review process.

work-in-progress (WIP) limit
A Kanban principle that restricts the number of active tasks a writer can work on at once to improve focus and flow.

World Wide Web Consortium (W3C)
The international standards organization for the World Wide Web that develops protocols and guidelines to ensure long-term growth of the web.

X

XML Localization Interchange File Format (XLIFF)
A standardized XML-based format used to exchange localization data between various tools during the translation process.

XML Schema Definition (XSD)
A recommendation that specifies the structure and data types allowed in an XML document, used to validate the content's integrity.

Y

YAML Ain't Markup Language (YAML)
A human-readable data serialization language frequently used for configuration files and metadata blocks in documentation source files.

Z

zero-result rate (ZRR)
An analytics metric measuring the percentage of search queries returning zero results, used to identify terminology or content gaps.

zero-result search
A search query performed by a user that returns zero results, serving as a data point to identify gaps in documentation.

zero-shot prompting
Instructing a large language model to execute an editorial task (such as active-voice translation) relying purely on its built-in linguistic training without provided examples.

zone of proximal development (ZPD)
An instructional design concept representing the gap between what a learner can do without help and what they can do with professional guidance.