Tech Writer's Guide

All tech writing resources

Every resource in the directory. Filter by category or search by name.

307 tech writing resources / page 8 of 9

Slab

Authoring & Help Tools

A knowledge base tool for internal team documentation that integrates with the existing tool stack and offers unified search.

slab.com

Typora

Authoring & Help Tools

A minimal desktop Markdown editor with a seamless live preview, commonly used by writers drafting documentation source files.

typora.io

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

Componize

Authoring & Help Tools

A DITA component content management system built on an enterprise content repository for structured technical documentation.

componize.com

Keystatic

Docs-as-Code Tools

An open-source content management tool from Thinkmill that edits Markdown and structured content stored in a Git repository.

keystatic.com

Docutils

Docs-as-Code Tools

The Python text processing system that defines and parses reStructuredText, forming the foundation that Sphinx is built on.

docutils.sourceforge.io

Gatsby

Docs-as-Code Tools

A React-based site framework that pulls content from Markdown, CMSs and APIs through a GraphQL layer to build static sites.

gatsbyjs.com

Prettier

Docs-as-Code Tools

An opinionated code formatter that also formats Markdown and MDX, often used to keep documentation source files consistent.

prettier.io

Red Hat supplementary style guide

Communities & Newsletters

Red Hat's public supplementary style guide for product documentation, layered on top of a general industry style reference.

redhat-documentation.github.io

DocsBot AI

Authoring & Help Tools

A service that trains a chatbot on a company's documentation and content so it can answer customer and internal questions.

docsbot.ai

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

Google developer documentation style guide

Communities & Newsletters

Google's openly published editorial style guide for developer documentation, widely adopted as a baseline by other teams.

developers.google.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

Supademo

Authoring & Help Tools

A tool for capturing and publishing interactive product demos and walkthroughs for onboarding, sales and support content.

supademo.com

Yelp

Authoring & Help Tools

The GNOME desktop help browser, which renders Mallard and DocBook help documents shipped with Linux desktop applications.

wiki.gnome.org

Markdown Guide

Docs-as-Code Tools

A free open-source reference that documents Markdown syntax, including the differences between common Markdown flavours.

markdownguide.org

markdownlint

Docs-as-Code Tools

A Node.js style checker and lint tool for Markdown and CommonMark files, commonly wired into documentation CI pipelines.

github.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

Hexo

Docs-as-Code Tools

A fast Node.js static site generator that renders Markdown into static pages, used for blogs and project documentation.

hexo.io

Hugo

Docs-as-Code Tools

A fast open-source static site generator written in Go, commonly used for documentation sites via themes such as Docsy.

gohugo.io

LanguageTool

Authoring & Help Tools

An open-source multilingual proofreading service that checks grammar, spelling and style in more than twenty languages.

languagetool.org

MDX

Docs-as-Code Tools

A format that lets writers embed JSX components directly in Markdown, used by many JavaScript documentation frameworks.

mdxjs.com

write-good

Docs-as-Code Tools

A simple English prose linter that flags common writing problems such as passive voice, weasel words and wordy phrases.

github.com

JSON Schema

API Documentation Tools

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

json-schema.org

Bookdown

Docs-as-Code Tools

An R package for writing long-form technical books and documents in Markdown, producing HTML, PDF and e-book output.

bookdown.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

This is important

Communities & Newsletters

Ryan Macklin's site collecting essays and posts, including a strand on technical writing and documentation practice.

thisisimportant.net

Carbon

Authoring & Help Tools

A tool that turns a snippet of source code into a styled image suitable for documentation, slides and social posts.

carbon.now.sh

CommonMark

Docs-as-Code Tools

A strongly defined and highly compatible specification of Markdown, with a reference implementation and test suite.

commonmark.org

Strapi

Docs-as-Code Tools

An open-source Node.js headless CMS that lets teams model content types and expose them over REST and GraphQL APIs.

strapi.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

DocuWriter.ai

Authoring & Help Tools

An AI tool that analyses a codebase and generates structured code documentation, API docs and test suites from it.

docuwriter.ai

OASIS DITA Technical Committee

Communities & Newsletters

The OASIS committee that develops and maintains DITA, the standard for structured, topic-based technical content.

oasis-open.org

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

Docs by Design

Communities & Newsletters

Bob Watson's blog on documentation design, user interface text and applying research methods to documentation.

docsbydesign.com

iA Writer

Authoring & Help Tools

A focused Markdown writing application with syntax highlighting for prose and a distraction-free editing mode.

ia.net