Tech Writer's Guide

API Documentation Tools

OpenAPI, GraphQL and source-code reference tooling: specification editors, linters, renderers, developer portals and SDK generators.

55 tech writing resources / page 2 of 2

Stoplight Elements

API Documentation Tools

A set of embeddable web components that render an interactive API reference from an OpenAPI description inside an existing site.

elements-demo.stoplight.io

DocC

API Documentation Tools

Apple's open-source documentation compiler for Swift, producing reference documentation and tutorials from source and Markdown.

swift.org

JSDoc

API Documentation Tools

An API documentation generator for JavaScript that reads structured comment blocks in source files and produces reference docs.

jsdoc.app

pdoc

API Documentation Tools

A zero-configuration API documentation generator for Python that builds reference docs from modules, docstrings and type hints.

pdoc.dev

pkg.go.dev

API Documentation Tools

The official Go package discovery site, which renders reference documentation for public Go modules directly from their source.

pkg.go.dev

Sphinx autodoc

API Documentation Tools

The Sphinx extension that pulls documentation directly from Python docstrings so reference pages stay tied to the source code.

sphinx-doc.org

APIs.guru

API Documentation Tools

An open directory of public REST API descriptions converted to OpenAPI 3 format, useful as reference material and test data.

apis.guru

RapiDoc

API Documentation Tools

An open-source web component that renders an interactive API reference from an OpenAPI description with a single HTML tag.

rapidocweb.com

Postman API Documentation

API Documentation Tools

Postman's documentation product, which generates and publishes API reference pages directly from collections and schemas.

postman.com

OpenAPI Initiative

API Documentation Tools

The Linux Foundation body that maintains the OpenAPI Specification, the vendor-neutral description format for HTTP APIs.

openapis.org

JSON Schema

API Documentation Tools

A vocabulary for annotating and validating JSON documents, underpinning the data models used in OpenAPI descriptions.

json-schema.org

mkdocstrings

API Documentation Tools

A MkDocs plugin that injects API reference generated from source code docstrings into a Markdown documentation site.

mkdocstrings.github.io

Breathe

API Documentation Tools

A Sphinx extension that brings Doxygen-generated C and C++ reference material into a Sphinx documentation project.

breathe.readthedocs.io

Sphinx RTD Theme

API Documentation Tools

The Read the Docs theme for Sphinx, one of the most recognisable layouts in open-source software documentation.

sphinx-rtd-theme.readthedocs.io

TypeDoc

API Documentation Tools

A documentation generator that converts TypeScript source and its type annotations into an API reference site.

typedoc.org

Magidoc

API Documentation Tools

An open-source generator that builds customisable static documentation websites from a GraphQL API schema.

magidoc.js.org

Slate

API Documentation Tools

An open-source template that produces a clean three-column static API reference site from Markdown source.

github.com

Furo

API Documentation Tools

A clean, customisable Sphinx theme designed for readability, with first-class light and dark modes.

pradyunsg.me

SpectaQL

API Documentation Tools

An open-source tool that generates a static documentation site from a GraphQL schema.

github.com