The Docs Like Code website, authored and curated by Anne Gentle, is a comprehensive resource for those interested in the Docs as Code methodology. It features a rich collection of tutorials, resources, and articles that delve into applying software development practices to documentation. The site showcases Anne Gentle's own insights and also includes contributions from various experts in the field. It's an invaluable resource for anyone from beginners to advanced practitioners seeking to enhance their documentation workflows with Docs as Code.
I authored a series of articles published on docslikecode.com, detailing our process of developing the documentation site for platformOS. This series offers in-depth insights into our approach, decisions, and planning. Each of the four parts focuses on a distinct aspect of our journey.
Published on: docslikecode.com
Publication date: October, 2018
In this part, I share how we started, how we got to know our audience, how we figured out what content we need, and how we outlined a sitemap for our documentation site.
Full articlePublished on: docslikecode.com
Publication date: November, 2018
In this part, I discuss how we started building templates and wireframes, how we approached the design, and how we started producing content.
Full articlePublished on: docslikecode.com
Publication date: November, 2018
In this part, I delve into community-driven documentation and the mechanisms we've implemented to support our users and continuously enhance our docs.
Full articlePublished on: docslikecode.com
Publication date: February, 2020
In this part, we take a look under the hood, and discuss the technologies we used, how we built our auto-generated API Reference, and how we pull content and related information from GitHub.
Full article