Why docs as code?
Why have I chosen to focus on docs as code? For several reasons. While I have no metrics to back this up, it is increasingly popular in the documentarian community, and a large number of documentation projects starting now and in the past few years are more likely to choose it as their workflow of choice. In certain fields, especially tools and services aimed at developers, it’s almost the only process used. The most important reason I focus on it is because this book is aimed at developers, and it’s the workflow that most developers will already be familiar with. Even if you have never written a word of documentation, I am almost certain that the process of using some form of text editor and sharing changes with others via version control is familiar to you.
Docs as code follows almost the same processes as, well, code. As I move beyond the basics toward the end of this chapter and into the following chapters, show that automating, testing, and much...