Docs Geek Blog
Welcome to the Docs Geek Blog, where I, Mark, your "Docs Geek," will guide you through the exciting world of modern technical writing. Join me as we dive deep into topics such as docs-as-code, workflow automation, SaaS/APIs, style guides, and the art of effective diagramming.
In this blog, I don't just talk theory; I walk the talk. I frequently provide links to GitHub repositories and Codepens containing sample applications that bring these concepts to life. These practical examples are your hands-on tools for experimenting with the very ideas we discuss.
Consider this blog your primer, launchpad, and trusted resource for exploring modern tech writing concepts in an informative but also practical and actionable way.
So, welcome aboard whether you're a seasoned technical writer, developer, or anyone interested in the dynamic world of documentation. Let's embark on this journey of discovery together, and let's geek out on all things docs!
Featured
Breaking the mold: task-oriented API documentation
Posted on:November 25, 2023 at 04:16 AMWhy API documentation should align with problem-solving rather than signal types.
Documenting database schemas
Posted on:October 8, 2023 at 10:33 PMDocumenting database schemas can pose challenges, particularly for tech writers without direct database access. This article offers best practices and strategies to document database schemas effectively.
Do you need to code for an API tech writing job? 🚀
Posted on:October 8, 2023 at 10:33 PMMany transitioning technical writers wonder if coding is necessary for API tech writing. While the extent of coding knowledge varies by role, this article explores essential skills, from API fundamentals to technical proficiency and tools.
Recent Posts
Breaking the mold: task-oriented API documentation
Posted on:November 25, 2023 at 04:16 AMWhy API documentation should align with problem-solving rather than signal types.
Documenting database schemas
Posted on:October 8, 2023 at 10:33 PMDocumenting database schemas can pose challenges, particularly for tech writers without direct database access. This article offers best practices and strategies to document database schemas effectively.
Do you need to code for an API tech writing job? 🚀
Posted on:October 8, 2023 at 10:33 PMMany transitioning technical writers wonder if coding is necessary for API tech writing. While the extent of coding knowledge varies by role, this article explores essential skills, from API fundamentals to technical proficiency and tools.