Technical writing with Continuous Integration and docs-as-code
An article I wrote on GitHub for the docslikecode.com website: What if you could use GitHub, static site generators, and Continuous Integration and Deployment (CI/CD) for our documentation? I imagine you can track your backlog and get some metrics on the quality with their nice contributor graphs. I bet you could measure “docs drift” to […]
Sometimes treating docs as code seems overly complicated. Let’s break it into component parts – static site generators, development environments, source control, continuous integration, hosting, deployment, and testing docs. Yes there is a stack here to learn, but now you can take tutorials one-at-a-time no matter where you are in a docs-as-code exploration. Go to […]
When you treat docs like code, you want to deploy that “code” to a web site. In our case, these code source files are doc source files. We want to see how something like a documentation site looks on a web site with a static site generator (SSG) like Jekyll. I had been practicing these […]