Skip to main content

Infrastructure & Platforms

Foundational systems that enable API development and documentation workflows. This subcategory includes both technical infrastructure - event streaming, message queues, cloud platforms - and organizational infrastructure - project management and issue tracking - that teams rely on to build, document, and ship APIs.

/* TODO: add Confluence, Jira, RabbitMQ, Redis, cloud platforms */


Kafka

Definition: also known as Apache Kafka; distributed event streaming platform that stores, processes, and transmits streams of events in real-time using it own binary TCP - Transmission Control Protocol

Purpose: enables building real-time data pipelines and streaming applications with high throughput, fault tolerance, and scalability; combines messaging, storage, and stream processing capabilities

Example: companies use Kafka to process millions of events per second for real-time analytics, log aggregation, and change data capture, with events persisted to disk for replay and historical analysis

Related Terms: AMQP, AsyncAPI, event-driven, message broker, MQTT

Sources:


Linear

Definition: project management and issue tracking software designed for software development teams with focus on speed, keyboard shortcuts, and streamlined workflows; related tools include Asana, ClickUp, Jira, Monday.com, and Notion

Purpose: helps development and docs teams track tasks, bugs, and feature requests with Git integration for automatic issue updates based on commit messages and pull request merges; commonly used in API docs projects for managing tickets, tracking docs debt, and coordinating releases between engineering and technical writing teams

Example: docs tasks tracking with Linear -

Flowchart showing steps: docs team uses Linear to track tasks, dev commits changes, Linear moves ticket, docs work stays synced with development
ToolBest ForAPI Docs StrengthsGit Integration
LinearSoftware development teams prioritizing speedNative Git integration, automatic issue updates from commits, keyboard-first workflowNative - GitHub, GitLab
AsanaCross-functional teams with diverse workflowsFlexible views, timeline planning, broad integrationsVia third-party apps
ClickUpTeams wanting all-in-one customizationHighly customizable, docs and tasks in one platform, multiple view typesVia integrations
JiraEnterprise software teams with complex processesPowerful issue tracking, extensive DevOps integrations, advanced workflowsNative - Bitbucket, GitHub, GitLab
Monday.comVisual workflow management across departmentsVisual boards, automation recipes, status-centric trackingVia integrations
NotionKnowledge management and lightweight project trackingExcellent for docs and task databases, flexible content creationVia third-party integrations

Related Terms: CI/CD pipeline, docs-as-code, Falconer, Git, GitHub, version control

Sources: