Us…

We are an agile bunch. We believe in using development tools and pushing the edges of imaginary boundaries for collaboration. Whether writing, deploying, reviewing, or merging, we treat docs like code. We appreciate developer techniques and workflows. We don’t know what we did before build automation; it’s so natural to have a robot make the docs and check the internal and external links.

We have used “docs like code” techniques for multiple projects in multiple contexts, from open-source software docs to blog posts to enterprise documentation sites. We know docs-as-code has taken the technical writing world into new directions, deeper into developer documentation.

You…

I know you. You want to learn and experiment with improving documentation by changing the way your organization thinks about docs? Then here is your opportunity to prove you can modernize your docs.

You need to know about docs like code; what is it? Why would you apply the techniques behind docs like code? You need a tutorial and quick wins to prove to yourself and your team that your docs are ready for a new mindset, a new toolset, and a new doc set.

The Docs Like Code book is available as a printed copy (on Lulu) or ebook on multiple platforms, including Amazon Kindle. But you don’t have to buy the book to get started. The docslikecode.com website has articles that tell other people’s stories about their journeys. In addition, there is a collection of tutorials to get you started. A recent tutorial on this site is Learn Git and GitHub Now with Three Doc Projects.

Go to the articles and learn from each other’s experiences.

Share your stories too! Get in touch if you would like to publish your journey to docs-as-code techniques either as a lone writer, tech pubs manager, developer, or on a team of technical writers.