Documentation as code - state of the art

docsAsCode.md

Free Tools

Terraform

• terraform-docs:
  1. Generate documentation from Terraform modules in various output formats.
  2. Can be imported in your project as a library (Go).
  3. GitHub Actions available (terraform-docs/gh-actions@main)
• mkdocs-terraform-monorepo-plugin
  1. This plugin enables you to build multiple sets of documentation in a single Mkdocs

Ansible

• ansible-doc-generator

HELM

• helm-docs

CloudFormation

• cf-doc

Go

General

• docsify
  1. No statically built html files
  2. Simple and lightweight
  3. Smart full-text search plugin
  4. Multiple themes
  5. Useful plugin API
  6. Emoji support
  7. Compatible with IE11
  8. Support server-side rendering (example)
• Read the Docs
  1. Whenever you push code to your version control, we will automatically build your docs so your code and documentation are never out of sync.
  2. We can host and build multiple versions of your docs.
  3. We will host your documentation for free, forever.
  4. We build and host your docs for the web, but they are also viewable as PDFs, as single page HTML, and for eReaders.
• Material for MkDocs
  1. Focus on the content of your documentation and create a professional static site in minutes.
  2. Make it yours – change the colors, fonts, language, icons, logo, and more with a few lines of configuration.
  3. Users can navigate your documentation with touch devices, keyboards, and screen readers.
  4. Get incredible value with a small footprint by using one of the fastest themes available with excellent performance
  5. Automatically adapts to perfectly fit the available screen estate, no matter the type or size of the viewing device
• Asciidoctor
  1. Provides a nice out-of-the-box HTML experience, complete with a default stylesheet and built-in integrations like Font Awesome (for icons), Highlight.js (highlighting), and MathJax.
  2. Asciidoctor provides converters for three output formats by default: HTML 5, DocBook 5, and man page (short for manual page).
  3. While Asciidoctor provides a built-in converter for producing publish-ready HTML, all the HTML that Asciidoctor generates can be changed.
  4. Multiple interfaces: CLI and API
• Tettra (Free Plan)
  1. When questions get asked in Slack, use the Slack integration to send a new or existing answer.
  2. Create content with Tettra's simple editor, or use existing Google Docs, markdown files, and more to build your knowledge base.
  3. Your teammates can request new pages or page updates to fill the gaps.

Refs

1. https://www.docslikecode.com/