All tech writing resources
Every resource in the directory. Filter by category or search by name.
Algolia DocSearch
Algolia's free search service for open-source documentation sites, which crawls a docs site and provides a hosted search index and UI.
Mendable
A tool for building AI chat applications over ingested documentation and technical content, with deployment and customisation options.
Mermaid
A JavaScript library that renders diagrams from a plain-text syntax, letting flowcharts and sequence diagrams live in Markdown source.
numpydoc
A Sphinx extension and docstring style convention originating in the NumPy project, widely adopted across scientific Python libraries.
Shiki
A syntax highlighter that uses TextMate grammars and VS Code themes to render code blocks in documentation exactly as an editor would.
VuePress
A Vue-powered static site generator created for technical documentation, where each Markdown page becomes a Vue single-file component.
Zudoku
An open-source framework for building API documentation sites from OpenAPI descriptions, with MDX pages and an interactive playground.
asciinema
An open-source tool and hosting service for recording terminal sessions as lightweight text-based casts that can be embedded in docs.
Hemingway Editor
A readability-focused editor that highlights long sentences, passive voice and complex phrasing to push writing toward plainer prose.
HugoBlox
An open-source structured-content framework built on Hugo, providing reusable blocks for documentation, portfolio and research sites.
draw.io
An open-source diagramming application for flowcharts, architecture and network diagrams, usable in the browser or as a desktop app.
Pygments
A Python syntax highlighting library supporting a very large number of languages, used by Sphinx and other documentation toolchains.
VHS
A command-line tool that scripts terminal recordings from a text file, producing reproducible GIFs and videos for CLI documentation.
Compodoc
An open-source documentation tool for Angular applications that generates a static site describing components, modules and routes.
Doc Detective
An open-source documentation testing framework that runs the steps described in docs against the product to check they still work.
Jekyll
A Ruby static site generator that turns Markdown and Liquid templates into a static site. It is the generator behind GitHub Pages.
Excalidraw
An open-source virtual whiteboard that produces hand-drawn style diagrams, often used for architecture sketches in documentation.
Stainless
A service that generates and maintains high-quality client SDKs from an OpenAPI description, used by several large API providers.
Widdershins
An open-source converter that turns OpenAPI, AsyncAPI and Semoasa definitions into Slate-compatible Markdown for static API docs.
Write the Docs Documentation Guide
The Write the Docs community guide to software documentation, collecting practices for writing, structuring and maintaining docs.
Apple writing guidelines
The writing section of Apple's Human Interface Guidelines, covering the words used inside an app as part of its user experience.
DocBook
A long-established XML schema for technical documentation, with stylesheets that publish the same source to HTML, PDF and print.
Stoplight Elements
A set of embeddable web components that render an interactive API reference from an OpenAPI description inside an existing site.
Astro
A web framework for content-driven sites that ships zero JavaScript by default and underpins the Starlight documentation theme.
DocC
Apple's open-source documentation compiler for Swift, producing reference documentation and tutorials from source and Markdown.
docs.page
A service that publishes a documentation site directly from a GitHub repository of Markdown files with no build or deploy step.
GitLab Documentation Style Guide
GitLab's openly published documentation style guide, notable as a worked example of a large open-source docs-as-code operation.
JSDoc
An API documentation generator for JavaScript that reads structured comment blocks in source files and produces reference docs.
pdoc
A zero-configuration API documentation generator for Python that builds reference docs from modules, docstrings and type hints.
pkg.go.dev
The official Go package discovery site, which renders reference documentation for public Go modules directly from their source.
Retype
A documentation site generator that builds a searchable static site from a folder of Markdown files with minimal configuration.
Write the Docs Slack
The Write the Docs chat network, an open Slack workspace where documentation practitioners discuss tools, careers and problems.
Zensical
A documentation site generator from the team behind Material for MkDocs, aimed at fast builds for large documentation projects.
Docsio
A documentation generator that produces a structured knowledge site intended to be readable by both users and AI search tools.
Sphinx autodoc
The Sphinx extension that pulls documentation directly from Python docstrings so reference pages stay tied to the source code.
Doctave Blog
Doctave's blog on docs-as-code best practices and technical writing technique, published alongside its documentation product.