Although I’ve been doing tech writing for enough years that this issue shouldn’t even be an issue, I’m still perplexed by best practices around document review. The right practices seem to vary from company to company, from toolset to toolset,… Continue Reading →
Although specification documentation (which covers technical information about product details), doesn’t involve much actual writing, it does require you to make many judgments about what information to include, how to gather and retrieve these details, and how to structure and… Continue Reading →
Jacob Moses has a podcast called The Not-Boring Tech Writer. Recently, he interviewed me for an episode titled Skill #26: Getting Started with API Documentation. Source: I’d Rather Be Writing Feed
In this podcast, I talk about how to deal with project overload, specifically covering strategies to manage tasks. Scrum is one framework for dealing with project work by allowing you to limit the work you have before you in a… Continue Reading →
I added a new article in my API doc course that expands the notion of docs as code to include not only tools but processes as well. I included an excerpt below and a link to the full article. Source:… Continue Reading →
Previous articles I’ve shared on documenting code introduced the complexity of the challenge. In this article, I expand on five different techniques writers take in documenting their code, including the Lego approach, the Nautilus approach, juxtaposed columns, and more. In… Continue Reading →
A reader recently asked how to collaborate with Git with other writers. He said they found it hard to develop a Git workflow that allowed them to work on content together and wondered if another approach might be more suitable…. Continue Reading →
I added another topic to the Documenting Code section in my API documentation course. This new topic is called Research on documenting code and summarizes/discusses two academic articles on documenting code. Source: I’d Rather Be Writing Feed
I recently added a new section in my API documentation course on documenting code. This is an entire section that I’m building out with about 7-8 topics. The introduction is called Why documenting code is so difficult. Source: I’d Rather… Continue Reading →
In episode 22 of the Write the Docs podcast, Giles Gaskell from Squiz in Australia joins us to talk about managing multiple doc projects across Git repositories through Antora. Giles explains how to establish processes such that updating documentation becomes… Continue Reading →
© 2024 bobbyxcunningham.com — Powered by WordPress
Theme by Anders Noren — Up ↑