Documenting and Formalizing Software Systems

Markdoc delivers a good user experience without compromising the authoring experience. It enables writers to express interactivity and simple page logic without mixing code and content.

The following document outlines Camunda’s writing techniques and practices to ensure uniform styling across Camunda documentation and to yield a more cohesive and organized user experience alongside a fast-growing staff.

Three documents I write (one-pager, design doc, after-action review) and how I structure them.

docToolchain is a collection of scripts that makes it easy to create and maintain powerful technical documentation. Built on best-of-breed open source technologies, we deliver the best docs toolchain so you don’t have to.

Terrastruct is a diagramming tool uniquely crafted for software architecture

Write your documentation in Markdown and create a professional static site in minutes – searchable, customizable, for all devices

Need to write a README file, but not sure what to say? If this is a frustration that bothers you frequently, you might consider beefing your document up with a diagram. After all, a picture is worth…

Documentation is often considered the boring, time-consuming, and difficult aspect of our work. But it’s important! In this daily digest, we’ll go through some guides, tools, and techniques to make…

A hundred things I learned writing my first technical book “Data-Oriented Programming”

A lightweight approach for effective software communication

Reference implementation for Serverless 2.0; Distributed State Management for Serverless

ReLaXed creates PDF documents interactively using HTML or Pug (a shorthand for HTML)

Automatically Generate Architecture Diagrams and Technical Documentation of Your Cloud Environments

Generate interactive API documentation from OpenAPI definitions

Bootiful Asciidoctor is a sample project by Josh Long which provides a Continuous Delivery pipeline for an asciidoctor-based documentation

pandoc is a universal document converter

Structured system designs, built to increase your teams understanding and trust in your docs. Based upon the C4 model.

Create beautiful cloud diagrams in minutes

Describe your diagrams with a simple text language and automatically generate an image you can export.

Build better, easy to understand network maps. Detailed network diagrams available for purchase.