API Docs Glossary

A comprehensive glossary of API documentation fundamental concepts, processes, tools, and best practices. This project originated from coursework in the University of Washington's AI-Enhanced API Documentation certification program. Thank you to Docs By Design and the Write the Docs community for inspiration and resources.

This glossary is a living document, intended to evolve as the terms do. The API Docs Glossary is a personal learning project, but suggestions and corrections are welcome. Visit the Contribution Guide for more information.

Topics

ADG includes but isn't limited to the following:

• API Fundamentals: core concepts, CRUD, HTTP, security, validation
• Documentation-Specific Concepts: AsyncAPI, OpenAPI specification, overview, reference, runbook
• API Types & Architectures: event-driven, GraphQL, gRPC, microservices, REST, SOAP, Webhook, WebSocket
• AI & APIs: AI agent, genAI, knowledge graph, liquid content, LLM, MCP server, RAG
• Tools & Techniques: cURL, Doc Detective, Git, Postman, Swagger, Vale
• Workflows & Methodologies: Agile, API docs testing, docs-as-code, docs-as-tests, usability testing
• Frameworks & Strategy: accessibility, Diátaxis, docs-as-ecosystem, DX, IA, KM, ontology, taxonomy, tech comm, UX
• Writing Style: content strategy, rhetorical approach, tone considerations

Get Started

This resource provides essential concept definitions and context for anyone working with and/or learning about API documentation. Visit the following documentation pages for more information:

• Introduction: find a path through the glossary
• Get Started: navigate glossary structure
• Quick Reference: find a specific term refresher
• How This Glossary is Built: learn about the current glossary tools and processes
• Style Guide: review the current glossary formatting and writing conventions

Prerequisites

• Node.js version 20.0+
• npm or yarn package manager

Installation

# Clone the repository
git clone https://github.com/yourusername/api-docs-glossary.git

# Navigate to the project directory
cd api-docs-glossary

# Install dependencies
npm install

Local Development

This command starts a local development server and opens up a browser window at http://localhost:3000/. Most changes display live without having to rebuild the project or restart the server.

# Start the development server
npm run start

Build

This command generates static content into the build directory, which any static contents hosting service can serve.

# Create a production build
npm run build

Build Components

• Docusaurus: Documentation site generator
• React: UI framework
• Markdown: Content format

Project Structure

api-docs-glossary/
├── docs/                  # Documentation Markdown/MDX files
├── src/                   # Custom React components and pages
├── static/                # Static visual assets
├── docusaurus.config.ts   # Docusaurus configuration
└── sidebars.ts            # Sidebar navigation configuration

License

This project is open source and available under the MIT License, visit the LICENSE for details.