Despite working as a technical writer for nearly 30 years, I’ve never been part of a “docs like code” project. So during a quieter period, I decided to find out what it is all about. There’s more to discover than I expected, so with these docs-like-code posts, I’m going to share what I learn so that hopefully, other newbies can pick up the basics along the way.
Who are these posts for?
I’m going to write these posts with two audiences in mind:
Technical writers who have little or no experience with docs like code (which is also me)
My future self, because unless I’m using it on real projects, I’ll forget it.
The posts are not aimed at developers or people who know docs like code very well. My aim is to learn the basics, from understanding the concepts to creating content, using version control, and publishing with a static site generator (more on those in later posts).
How am I learning docs like code?
I’m going to use anything I can get my hands on! To begin with, I’ve been using Udemy training courses and I’ve been asking fellow technical writers with expertise in this area. I’ve also been using ChatGPT, though obviously that’s time-consuming as it’s not always accurate.
I’ll add links to the courses below.
Markdown mastery (Udemy)
Git and GitHub for writers (Udemy)
Links to my docs like code posts
Below, I’ll add links to the posts as and when I write them.
