Continuous Integration, Deployment (or Delivery), and even Release are well-known concepts for developers and cloud engineers. Teams work hard to crea

The case for Continuous Documentation - VirtualLifestyle.nl

submited by
Style Pass
2021-06-06 08:30:15

Continuous Integration, Deployment (or Delivery), and even Release are well-known concepts for developers and cloud engineers. Teams work hard to create pipelines that do most of the repetitive work for them, reducing the cognitive load and reducing toil. The pipelines are a second brain of sorts that remembers to do every little check, test, or task at exactly the right moment, automatically integrating, testing, deploying and observing our software for us. These continuous improvement patterns and workflow automation are key aspects of any high-performing software and cloud engineering environment. While these steps are different for every pipeline, in general, they fall into one of the three test, build, and deploy buckets; each performing a series of automated steps and tasks to get code to production. But, as the title reveals: what about documentation? Why do we sweep documentation under the rug? Why do we not have a separate Continuous Documentation bucket?

Continuous Documentation is a behavioral and organizational pattern that closes the loop between changes in a code base and its documentation by using automation (documentation-as-code) and standardized workflows and pipelines.

Leave a Comment