Hero Image

Documenting and Formalizing Software Systems

Documenting and Formalizing Software Systems

Resources

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

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

Communicating Software - A lightweight approach for effective software communication

A lightweight approach for effective software communication

Distributed State Management for Serverless - Cloudstate

Reference implementation for Serverless 2.0; Distributed State Management for Serverless
Spec

RelaxedJS

ReLaXed creates PDF documents interactively using HTML or Pug (a shorthand for HTML)
GitHub icon Open source

Cloudockit – Generate your cloud documentation

Automatically Generate Architecture Diagrams and Technical Documentation of Your Cloud Environments
PDF

Generate interactive API documentation from OpenAPI

Generate interactive API documentation from OpenAPI definitions
GitHub icon Open source

Bootiful Asciidoctor

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

Pandoc

pandoc is a universal document converter
GitHub icon Open source

IcePanel | Easily communicate complex systems

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

Isoflow | Network diagrams

Create beautiful cloud diagrams in minutes
PDF

Diagram.codes

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

17 Tips for Creating Better Network Diagrams

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

Diagrams · Diagram as Code

Diagrams lets you draw the cloud system architecture in Python code.

Asciidoctor Diagram

Asciidoctor Diagram is a set of Asciidoctor extensions that enable you to add diagrams, which you describe using plain text, to your AsciiDoc document.

How to Write and Format a White Paper (With Examples)

A white paper is an in-depth report or guide about a specific topic and the problems that surround it. It is meant to educate readers and help them to understand and solve an issue.

18 Software Documentation Tools that Do The Hard Work For You | Process Street | Checklist, Workflow and SOP Software

Without documentation, software is just a black box. And black boxes aren't anywhere near as useful as they could be because their inner workings are hidden from those who need them in the open. Software documentation turns your software into a glass box by explaining to users and developers how it operates or is used. You've probably seen […]

How do you manage documentation for your SaaS?

Documentation is often something, I personally, find hard to maintain. Do you use a service that makes documentation easy and painless? Specifically, I'...