Skip to main content

Quick Reference

This quick reference provides concise definitions and filing locations for common terms across technical writing, development, and project management. Look up terminology and find where terms belong in the full documentation structure.

A​

affect vs effect​

  • affect - verb: to influence
  • effect - noun: the result

Glossary Term Entry Location: Writing Style - affect vs effect

Agile​

  • project management method
  • breaks projects down into smaller phases, relies on iterative cycles

Glossary Term Entry Location: Workflows & Methodologies - Agile

AI​

  • acronym for Artificial Intelligence
  • a research field
  • set of technologies that use computers and large datasets to perform tasks
  • make predictions or recommendations and solve problems that normally require human intelligence

Glossary Term Entry Location: AI & APIs - AI

API​

  • application programming interface
  • enables resource sharing

Glossary Term Entry Location: Core Concepts - API

API endpoint​

  • specific URL where an API can access resources
  • client touchpoint with the API server

Glossary Term Entry Location: Core Concepts - API endpoint

API gateway​

  • server as single entry for many backend services
  • enables centralized security, monitoring, and versioning without clients needing to know about backend architecture

Glossary Term Entry Location: APT Types & Architectures - API gateway

API overview topic​

  • landing page in which the audience is everyone

Glossary Term Entry Location: Core Concepts - API overview topic

API reference topic​

  • "getting finished topics" that describe aspects of an API operation or object

Glossary Term Entry Location: Core Concepts - API reference topic

API security​

  • measures taken to protect APIs from unauthorized access, misuse, attacks

Glossary Term Entry Location: Core Concepts - API security

authentication​

  • API security measure that determines who users are

Glossary Term Entry Location: Core Concepts - authentication

authorization​

  • An API secutiry measure that determines what users can do

Glossary Term Entry Location: Core Concepts - authorization

B​

branch​

  • version control concept
  • Git feature
  • parallel version of a code repository and/or separate line of development in a repository

Glossary Term Entry Location: Tools & Techniques - branch

C​

cherry-pick​

  • version control concept
  • Git feature
  • copying selected commits from one branch to another branch

Glossary Term Entry Location: Tools & Techniques - cherry-pick

clone​

  • version control concept
  • Git feature
  • copy of a code repository that lives in the development environment, instead of hosted on GitHub

Glossary Term Entry Location: Tools & Techniques - clone

cognitive dimensions of API usability​

  • framework for evaluating and enhancing the usability of APIs
  • includes 12 dimensions

Glossary Term Entry Location: Frameworks & Strategy - cognitive dimensions of API usability

commit​

  • version control concept
  • Git feature
  • code repository snapshot at a certain point-in-time
  • includes commit hash

Glossary Term Entry Location: Tools & Techniques - commit

commit hash​

  • version control concept
  • Git feature
  • alphanumeric unique identifier auto-generated for each commit by using the SHA-1 hash function

Glossary Term Entry Location: Tools & Techniques - commit hash

concept​

  • documentation topic type
  • provides understanding without instructing readers to perform specific tasks
  • answer "what" and "why" questions at an accessible, introductory level

Glossary Term Entry Location: Core Concepts - concept

content​

  • anything written for someone else to read

Glossary Term Entry Location: Writing Style - content

Critical Chain Project Management​

  • also known as CCPM
  • project management method
  • focuses on resources needed to complete the project’s tasks by adding resource availability to the critical path

Glossary Term Entry Location: Workflows & Methodologies - Critical Chain Project Management

Critical Path Method​

  • also known as CPM
  • project management method
  • identifying a "critical path" of task sequences
  • some tasks can't start until previous ones finish

Glossary Term Entry Location: Workflows & Methodologies - Critical Path Method

CRUD​

  • acronym for "Create, Read, Update, Delete"
  • provides a standard framework for API operations that maps directly to HTTP methods

Glossary Term Entry Location: Core Concepts - CRUD

cURL​

  • acronym for "client URL"
  • command-Line tool available on Windows, MacOS, Linux
  • sends and receives HTTP and/or HTTPs requests

Glossary Term Entry Location: Tools & Techniques - cURL

D​

DELETE​

  • HTTP method
  • requests removal of a specified resource from the server

Glossary Term Entry Location: Core Concepts - DELETE

Document Development Life Cycle​

  • also known as DDLC
  • process of writing and delivering particular content in the form of documentation
  • example formats: PDF, Word doc, online articles, website content

Glossary Term Entry Location: Workflows & Methodologies - Document Development Life Cycle

domain knowledge​

  • understanding of a specific industry, discipline, or activity

Glossary Term Entry Location: Frameworks & Strategy - domain knowledge

E​

end-user software engineer​

  • way to describe and categorize different developer work styles, characteristics, and motivations that are common to particular groups of people or personas using products
  • typically includes three personas

Glossary Term Entry Location: Frameworks & Strategy - end-user software engineer

error handling​

  • process of anticipating, detecting, and responding to errors that occur during API operations
  • enables developers to build robust applications

Glossary Term Entry Location: Core Concepts - error handling

event-driven​

  • architectural pattern where actions trigger in response to specific events
  • reduces unnecessary network traffic and server load

Glossary Term Entry Location: API Types & Architectures - event-driven

explanation guide​

  • documentation topic type
  • clarifies a single topic without providing step-by-step instructions
  • focuses on comprehensive understanding of concepts, principles, or features

Glossary Term Entry Location: Core Concepts - explanation guide

F​

force push​

  • version control concept
  • Git feature
  • moving changes upstream that rewrite commits that are already present upstream

Glossary Term Entry Location: Tools & Techniques - force push

fork​

  • version control concept
  • Git feature
  • a forked code repository
  • personal copy of another user’s repository that lives in one's GitHub account

Glossary Term Entry Location: Tools & Techniques - fork

G​

genAI​

  • acronym for Generative AI
  • draws upon the patterns identified through machine learning processes to generate new content

Glossary Term Entry Location: AI & APIs - genAI

GET​

  • read-only HTTP method
  • the most common method for retrieving information

Glossary Term Entry Location: Core Concepts - GET

getting started​

  • documentation topic type
  • also known as "get started"
  • comprehensive onboarding documentation that helps new users complete their first meaningful interaction with a product or feature

Glossary Term Entry Location: Core Concepts - getting started

Git​

  • command-line program that executes version control functions

Glossary Term Entry Location: Tools & Techniques - Git

Git Bash​

  • command-line interface for Windows that emulates the Unix Bash command line

Glossary Term Entry Location: Tools & Techniques - Git Bash

GitHub​

  • cloud-based storage, version control, and automation service

Glossary Term Entry Location: Tools & Techniques - GitHub

GitHub Desktop​

  • user interface that manages GitHub repositories and local clones

Glossary Term Entry Location: Tools & Techniques - GitHub Desktop

glossary​

  • documentation topic type
  • alphabetically organized collection of terms and their definitions

Glossary Term Entry Location: Core Concepts - glossary

GraphQL API​

  • uses GraphQL, Graph Query Language - to enable clients to request exactly the data they need through a single endpoint
  • valuable for complex, interconnected data models

Glossary Term Entry Location: API Types & Architectures - GraphQL API

gRPC API​

  • uses gRPC - Google's Remote Procedure Call - framework
  • relies on Protocol Buffers

Glossary Term Entry Location: API Types & Architectures - gRPC API

guerrilla usability testing​

  • way to assess how effective an interface is by testing out its visual design, capability, and general message on its intended audience and capturing their responses
  • typically low maintenance with predefined tasks

Glossary Term Entry Location: Workflows & Methodologies - guerrilla usability testing

GUI​

  • acronym for graphical user interface
  • form of user interface with graphical icons and visual indicators

Glossary Term Entry Location: Tools & Techniques - GUI

H​

how-to guide​

  • documentation topic type
  • step-by-step instructions for completing a specific real-world task

Glossary Term Entry Location: Core Concepts - how-to guide

HTTP​

  • acronym for Hypertext Transfer Protocol
  • synchronous request/response protocol
  • enables communication between clients and servers over the web

Glossary Term Entry Location: Core Concepts - HTTP

HTTP method​

  • defines what operation the client wants the server to execute
  • makes it clear whether a request reads, creates, updates, or deletes data

Glossary Term Entry Location: Core Concepts - HTTP method

HTTPS​

  • acronym for Hypertext Transfer Protocol Secure
  • protects data from interception and tampering during transmission

Glossary Term Entry Location: Core Concepts - HTTPS

HTTP status codes​

  • three-digit codes servers return in HTTP responses
  • show whether a specific request succeeded or failed

Glossary Term Entry Location: Core Concepts - HTTP status codes

HTTP versions​

  • iterations of the Hypertext Transfer Protocol with different performance and feature capabilities
  • HTTP/1.1 (1997) uses sequential requests
  • HTTP/2 (2015) enables concurrent requests over one connection
  • HTTP/3 (2022) uses QUIC protocol for improved reliability

Glossary Term Entry Location: Core Concepts - HTTP versions

I​

idempotent​

  • describes an operation that produces the same result regardless of how many times it's executed
  • enables safe request retries without unintended side effects

Glossary Term Entry Location: Core Concepts - idempotent

introduction​

  • documentation topic type
  • explains what a product or feature is, why it exists, and what problems it solves

Glossary Term Entry Location: Core Concepts - introduction

J​

JSON​

  • acronym for JavaScript Object Notation
  • text-based data format that uses human-readable key-value pairs to represent structured data

Glossary Term Entry Location: Core Concepts - JSON

L​

Large Language Model​

  • also known as an LLM
  • form of generative AI that's trained on enormous amounts of text
  • can generate text-based responses that look and feel human-like

Glossary Term Entry Location: AI & APIs - Large Language Model

M​

Machine Learning​

  • practice of using algorithms and large datasets to train computers to recognize patterns and to apply what's known about those patterns to complete new tasks

Glossary Term Entry Location: AI & APIs - Machine Learning

Markdown​

  • markup language designed to format plain text documents

Glossary Term Entry Location: Tools & Techniques - Markdown

market​

  • space in which customers access a company and/or products that compete with similar offerings

Glossary Term Entry Location: Frameworks & Strategy - market

merge​

  • version control concept
  • Git feature
  • moving the changes from one branch to another branch

Glossary Term Entry Location: Tools & Techniques - merge

merge commit​

  • version control concept
  • Git feature
  • a commit that after branching, integrates changes from a feature branch with updates that occurred in the original branch

Glossary Term Entry Location: Tools & Techniques - merge commit

merge conflict​

  • version control concept
  • Git feature
  • scenario in which two commits have changes in the same file
  • blocks merging and requires manual resolution

Glossary Term Entry Location: Tools & Techniques - merge conflict

microservices​

  • architectural approach
  • apps as a collection of small, independently deployable services

Glossary Term Entry Location: API Types & Architectures - microservices

N​

Natural Language Processing​

  • also known as NLP
  • ability of computers to analyze and generate responses in ways that mimic humans’ use of language

Glossary Term Entry Location: AI & APIs - Natural Language Processing

O​

onboarding guide​

  • documentation topic type
  • new team member handbook designed to reduce time-to-productivity

Glossary Term Entry Location: Core Concepts - onboarding guide

OpenAPI Specification​

  • also known as the OAS
  • a standard, language-agnostic way to define an API interface
  • used to create the interface and documentation
  • format: YAML

Glossary Term Entry Location: Core Concepts - OpenAPI Specification

origin repository​

  • version control concept
  • default upstream repository, typically clone source repository

Glossary Term Entry Location: Tools & Techniques - origin repository

P​

parameters​

  • variables passed in API requests
  • specify, filter, or change data based on the operation in use

Glossary Term Entry Location: Core Concepts - parameters

PATCH​

  • HTTP method
  • applies partial modifications to an existing resource

Glossary Term Entry Location: Core Concepts - PATCH

payload​

  • defines what data clients send and receive
  • actual data transmitted in an API request or response body

Glossary Term Entry Location: Core Concepts - payload

POST​

  • HTTP method
  • submits data to a server to create new resources

Glossary Term Entry Location: Core Concepts - POST

Postman​

  • API development platform
  • commonly used for REST API development and testing workflows

Glossary Term Entry Location: Tools & Techniques - Postman

project management methodology​

  • different ways to approach and organize a project
  • ranges from sequential to iterative frameworks

Glossary Term Entry Location: Workflows & Methodologies - project management methodology

Protocol Buffers​

  • developed by Google
  • language and platform neutral mechanism for serializing structured data
  • enables strongly typed contracts between services

Glossary Term Entry Location: Tools & Techniques - Protocol Buffers

pull​

  • version control concept
  • Git feature
  • fetching changes from upstream, such as pulling the changes down from an origin or upstream repository

Glossary Term Entry Location: Tools & Techniques - pull

pull request​

  • also known as a PR
  • version control concept
  • GitHub feature
  • request to another user that invites them to pull one's changes from a repository/branch into their repository

Glossary Term Entry Location: Tools & Techniques - pull request

push​

  • version control concept
  • Git feature
  • moving changes upstream, such as from a local computer to its origin repository

Glossary Term Entry Location: Tools & Techniques - push

PUT​

  • HTTP method
  • replaces an existing resource with new data
  • creates a resource at a specific URL if it doesn't exist

Glossary Term Entry Location: Core Concepts - PUT

Q​

quickstart​

  • documentation topic type
  • the absolute least amount of steps needed to achieve first success with a product

Glossary Term Entry Location: Core Concepts - quickstart

R​

rate limiting​

  • mechanism that restricts the number of API requests a client can make within a specified time window
  • prevents abuse, maintains service stability, and ensures fair access for all users

Glossary Term Entry Location: Core Concepts - rate limiting

real-time​

  • describes systems and/or APIs that process data with minimal delay
  • supports use cases requiring instant updates

Glossary Term Entry Location: API Types & Architectures - real-time

rebase​

  • version control concept
  • Git feature
  • used to resync a feature branch to its source branch after the source branch has changed

Glossary Term Entry Location: Tools & Techniques - rebase

reference​

  • documentation topic type
  • provides detailed, factual information or system specifications
  • designed for lookup rather than learning

Glossary Term Entry Location: Core Concepts - reference

repository​

  • place to store files that are under Git’s version control

Glossary Term Entry Location: Tools & Techniques - repository

request/response​

  • two-part communication pattern in API interactions
  • client sends a request
  • server returns a response

Glossary Term Entry Location: Core Concepts - request/response

resource​

  • REST architecture fundamental concept
  • distinct piece of data or entity available for reference or modification through an API

Glossary Term Entry Location: Core Concepts - resource

REST API​

  • acronym for REpresentational state transfer, application programming interface
  • a convention, not a regulated standard
  • an architectural style for distributed hypermedia systems
  • one of the most widely used approaches for building web-based APIs

Glossary Term Entry Location: API Types & Architectures - REST API

REST vs RESTful​

  • "REST" refers to the architectural style
  • "RESTful" describes APIs that follow REST principles
  • terms are often used interchangeably

Glossary Term Entry Location: API Types & Architectures - REST vs RESTful

RFC​

  • acronym for Request for Comments
  • IETF - Internet Engineering Task Force - concept
  • numbered technical documents
  • provide authoritative specifications for web standards

Glossary Term Entry Location: Tools & Techniques - RFC

rhetorical approach​

  • communication framework
  • also known as "the tone" or "editorial voice"

Glossary Term Entry Location: Writing Style - rhetorical approach

RPC API​

  • acronym for Remote Procedure Call API
  • simplifies distributed computing
  • allows clients to execute functions on remote servers as if calling local functions

Glossary Term Entry Location: API Types & Architectures - RPC API

runbook​

  • documentation topic type
  • provides standardized instructions for operational or maintenance activities

Glossary Term Entry Location: Core Concepts - runbook

S​

sales collateral​

  • communications strategy focused on business value
  • materials used internally to inform sales representatives or externally to educate and convert prospective customers

Glossary Term Entry Location: Frameworks & Strategy - sales collateral

schema​

  • also known as the Schema Object
  • describes the structure, data types, constraints, and relationships within an API's requests and responses
  • enables validation, auto-generated documentation, and type safety

Glossary Term Entry Location: Core Concepts - schema

Scrum​

  • project management method
  • Agile framework
  • work in short-cycles of 2 weeks call “sprints”
  • meet daily to discuss work

Glossary Term Entry Location: Workflows & Methodologies - Scrum

serialization​

  • process of converting data structures and/or objects for network transmission or storage, then reconstruction
  • enables data exchange between systems

Glossary Term Entry Location: Core Concepts - serialization

skunkworks​

  • used in business, engineering, and technical fields to describe a group within an organization given a high degree of autonomy and unhampered by bureaucracy
  • typically given the task of working on advanced or secret projects

Glossary Term Entry Location: Frameworks & Strategy - skunkworks

SOAP API​

  • acronym for Simple Object Access Protocol
  • uses XML-based messaging protocol to exchange structured information between systems
  • was the enterprise API standard before REST took over

Glossary Term Entry Location: API Types & Architectures - SOAP API

squash​

  • version control concept
  • Git feature
  • action of combining many commits into a single commit

Glossary Term Entry Location: Tools & Techniques - squash

Swagger​

  • open source suite for REST API development
  • based on OpenAPI specification

Glossary Term Entry Location: Tools & Techniques - Swagger

T​

task​

  • documentation topic type
  • focuses on "how to" perform an action with step-by-step instructions

Glossary Term Entry Location: Core Concepts - task

top-level​

  • documentation topic type
  • introduces a subject area and provides navigation to related topics

Glossary Term Entry Location: Core Concepts - top-level

troubleshooting​

  • documentation topic type
  • helps users diagnose and resolve specific problems or error conditions

Glossary Term Entry Location: Core Concepts - troubleshooting

tutorial​

  • documentation topic type
  • guides users through a complete, real-world scenario from start to finish

Glossary Term Entry Location: Core Concepts - tutorial

U​

upstream repository​

  • version control concept
  • original repository, source of fork

Glossary Term Entry Location: Tools & Techniques - upstream repository

URI​

  • acronym for Uniform Resource Identifer
  • standard format for identifying resources
  • forms the foundation for both URLs and URNs

Glossary Term Entry Location: Core Concepts - URI

URL​

  • acronym for Uniform Resource Locator
  • specific URI type that includes network location
  • defines exactly where endpoints exist, how to reach them

Glossary Term Entry Location: Core Concepts - URL

usability testing​

  • practice of testing how easy a design is to use with a group of representative users

Glossary Term Entry Location: Workflows & Methodologies - usability testing

UI​

  • acronym for user interface
  • space where interactions between humans and machines occur

Glossary Term Entry Location: Tools & Techniques - UI

V​

validation​

  • process of checking whether data meets specified requirements before processing or storage
  • ensures data quality and improves API reliability

Glossary Term Entry Location: Core Concepts - validation

version control​

  • system that tracks changes in documents and other files

Glossary Term Entry Location: Tools & Techniques - version control

W​

Waterfall​

  • project management method
  • traditional, sequential, linear, idealistic

Glossary Term Entry Location: Workflows & Methodologies - Waterfall

webhook API​

  • pattern that enables event-driven integrations
  • service sends a POST request to client-specified URLs when specific events occur

Glossary Term Entry Location: API Types & Architectures - webhook API

WebSocket API​

  • also known as WebSockets
  • enables real-time data exchange without repeated HTTP requests
  • maintains persistent, client and server bidirectional connections

Glossary Term Entry Location: API Types & Architectures - WebSocket API

workspace​

  • local computer directory that stores cloned repositories

Glossary Term Entry Location: Tools & Techniques - workspace

X​

XML​

  • acronym for Extensible Markup Language
  • commonly used for data exchange in APIs and configuration files
  • essentially replaced by JSON, but remains in legacy integrations

Glossary Term Entry Location: Tools & Techniques - XML