Skip to content
Johnny Starlight

Docs-as-code

What Is Docs-as-code?

Section titled “What Is Docs-as-code?”

Docs-as-code is a technical writing environment where the technical writer uses the same tools as the software developers. When documenting softwares, this eases the reviewing process and increases the collaboration possibilities.

Benefits

Section titled “Benefits”

If using Docs-as-code with Markdown compared with DITA, includes the following benefits:

  • Smoother and faster reviewing process.
  • Flexibility when working with information layout.
  • Installing add-ons to make the documentation into a product.

Add-ons To Integrate

Section titled “Add-ons To Integrate”

The following add-ons are great extensions to the docs-as-code environment:

  • Litlyx
    • Litlyx is a Traffic Analytics site from Italy, Europe. The installation process is quick and the product is GDPR compliant. See Litlyx webpage for more information.
  • Swagger
    • Swagger is an API preview documentation tool. The tool provides example requests and example of a return object. See Swagger webpage for more information.
  • GitLens
    • GitLens is a git viewing tool. This tool visualizes the git branches and provides insights to the git history.
    • GitLens is especially helpful when new to git. See GitLens wepage for more information.

Further reading

Section titled “Further reading”