bobbyxcunningham.com

Professional Technical Writer

Category

technical-writing

My Knowledgebase Ninjas podcast episode — "Metrics don't work"

I recently appeared on the Knowledgebase Ninjas podcast in an episode titled Metrics Don’t Work. In the podcast, I chat with Gowri Ramkumar about documentation processes, why metrics are problematic, advantages and disadvantages of docs-as-code models, why measuring doc traffic… Continue Reading →

Are technical writers increasingly playing non-technical roles? Some thoughts on the evolution of technical writing roles

How is the role of the technical writer evolving? It seems we’re moving away from writing and more towards other roles, such as reviewer/convener, user champion, editor, publisher, and promoter. However, it’s difficult to gauge change, especially across different job… Continue Reading →

Staying updated about what developers are changing — my techniques for information sleuthing

In an ideal world, developers include technical writers in all relevant meetings and keep them updated about changes they’re making that might affect the docs. If this is the case for you, count yourself lucky. More often than not, however,… Continue Reading →

2020 Developer documentation survey

Around this time of year, I tend to look at tech comm trends for the previous and upcoming year. As I surveyed other tech comm posts about trends, two recent research efforts articles stand out as informative and research-based. Both… Continue Reading →

WTD Podcast episode 26: Technical writing and Reddit, with Alan Bowman

In episode 26 of the Write the Docs podcast, we talk with Alan Bowman about the technical writing forum on Reddit as well as the WTD Slack channel, comparing and contrasting the two spaces. Topics covered include pros and cons… Continue Reading →

Matching documentation review practices to company culture

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 →

Some specifications docs I've been working on — and thoughts on strategies and techniques for managing specs

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 →

Podcast: Dealing with Project Overload — Strategies to Manage Overflowing Documentation Tasks

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 →

Can you collaborate on doc projects in Git with other writers?

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 →

WTD Episode 22: Managing multiple doc projects across Git repositories, with Giles Gaskell

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 NorenUp ↑