Active documentation

Documenting, a task that is perceived as “expensive” but that in the long term is profitable.

Image for post
Image for post
Photo by Hack Capital on Unsplash

It is very easy for our documentation to cool

Image for post
Image for post
Image for post
Image for post
Image for post
Image for post

Software archeology

How to start

Introducing active documentation pipelines

Image for post
Image for post

Markdown as central format

Image for post
Image for post

Other non-active documentation

Readme files

Glossaries

Conventions and nomenclature

Additional challenges

Versioning

Implications when sharing the documentation repository with the code repository

Ensure maintenance of non-active documentation

Written by

Software developer @ basterrika.com

Get the Medium app

A button that says 'Download on the App Store', and if clicked it will lead you to the iOS App store
A button that says 'Get it on, Google Play', and if clicked it will lead you to the Google Play store