How to create a versioned docs site with Jekyll
Versions of software product or a service need documentation sites to match those version numbers. As I investigated and learned more, I found layers of complexity when using a source control system to...
View ArticleHow to Get Good Reviews with Docs-as-Code using GitHub
When using docs-as-code techniques, writers might hesitate to work with others on content deliverables, and developers might feel they have little to contribute to the documentation. I assert is that...
View ArticleHow to Choose a GitHub Plan for Technical Writing?
You may find that the free plan gives you all you need, but for four dollars a month, access to Codespaces, Pages, and Wikis are right in the sweet spot for technical writers using GitHub and...
View ArticleSurprisingly Affordable Startup Costs for Writing a Book on GitHub
What does it take to put together a website, a book, an ebook, all for sale online? Let’s look at costs for tools and services that make it happen. Let’s look at what you need for a book idea. You need...
View ArticleDiscover the New Edition of Docs Like Code: Available Now
Five years have passed since the last update to the Docs Like Code book. This time the book has earned a new subtitle: Collaborate and Automate to Improve Technical Documentation. If you’ve already...
View ArticleHow to Leverage Content Strategy Snippets
I used to drive up and down I-35 to get to my job (in a reclaimed mall) at Rackspace in San Antonio. I passed by Buc-ee’s and their billboards many times on that drive. Buc-ee’s is a super-charged...
View ArticleGet a Docs-as-Code Job by Volunteering in Open Source
As a technical writer interested in learning docs-as-code, volunteering in open source can be a great way to gain experience and develop your skills. It’s a path I took early in my career; I learned...
View ArticlePower Versus Simplicity With Markdown And Asciidoc
You can use either Markdown or Asciidoc for creating and formatting digital content. While both languages serve a similar purpose, they have distinct differences that suit them for different use cases....
View ArticleGitHub for Managing Tech Docs
GitHub is a popular platform for software developers to manage their code repositories, collaborate on projects, and track changes over time. However, it is also a powerful tool for technical writers...
View ArticleLet’s Find Out: When Do Static Site Generators Do Rendering?
Pre-rendering and progressive rendering are two techniques used by static site generators to improve website performance and user experience. Rendering is generating HTML. In the case of Static Site...
View Article
More Pages to Explore .....