API The Docs Virtual Series 2020 -- Upcoming presentations and thoughts on the virtual format
I'm giving a presentation on May 27 in the API The Docs Virtual series titled How Trends in API Documentation Differ from Other Tech Comm Trends. You can register for free on EventBrite. API The Docs is typically a one-day conference event but has gone virtual and is experimenting with different formats in interesting ways. In this post, I also share a few thoughts on the first virtual sessions and the challenges of finding the right online format for conferences.
Write the Docs Podcast episode 29: Salary Survey results and WFH tips, with Eric Holscher
In this episode, we chat with Eric Holscher, co-founder of both Read the Docs and Write the Docs, about the recent Salary Survey that the WTD group conducted. This survey was launched in Fall 2019, and the results published were recently published. The salary survey covers details such as types of employment, job titles, roles, length of time in role, work location, annual salary, salary breakdowns by state, additional benefits, satisfaction, reasons for dissatisfaction, organization type, respondent demographics, and more. In addition to exploring the survey, we also chat about tips for working from home, especially given that both Eric and Chris have been working remotely for many years.
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 categories. In some scenarios, writing might never have been why we were hired.
Podcast: Users as producers of knowledge -- conversation with Nupoor Ranade about how tech writer roles are changing
How can users shape and influence the documentation you're producing? In this podcast, I chat with Nupoor Ranade, PhD candidate at North Carolina State University, about how the roles of technical writers are changing. Instead of writers authoring content for passive users, users are actively directing and shaping the knowledge that writers produce. In this podcast, we look at ways docs-as-code workflows are facilitating that shift in roles. This podcast is more of a conversation, where I first ask Nupoor a series of questions, and then she asks me questions. There's also a transcript of the podcast.
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, technical writers are left out of the loop until the last minute, when someone remembers that the docs likely need to be updated (or should have been updated prior to release). This scenario is just as true whether everyone is working from home or in the office. One solution for this is to embrace a technique for information sleuthing.
Write the Docs Podcast episode 28: UX writing processes and considerations
Write the Docs podcast episode 28 is a recording of a Berlin WTD meetup focused on UX writing processes and considerations. The event was live streamed on March 9, 2020 at the Humanitec in Berlin by Chris Ward.
Tech comm podcasts are growing -- here's a list
Podcasts seem to be growing now more than ever. Here's a list of more than ten technical writing podcasts that you can listen to.
Life on reset -- new dynamics emerging
With the shift to sheltering in place and working from home, I've noticed that my family has grown closer together and that working remotely goes better when everyone is also remote.
Working from home — things I've bought
Now that most of us are working from home, I thought I might write a post about things I've bought in an effort to be more comfortable and productive in wfh mode.
How life has changed with the pandemic
These past two weeks have been incredibly disruptive in terms of world events, and while I usually avoid writing about current events and tend to stay within the tech comm focus, it seems like ignoring the elephant in the room not to mention something about the Coronavirus pandemic.
Webinar recording: How Trends in API Documentation Differ from other Tech Comm Trends
I recently gave a webinar on trends in developer docs to the STC Washington DC chapter on March 12, 2020. In this presentation, I presented the results and analysis of my Trends in Developer Documentation 2020 survey. A recording and audio file is available below.
Introduction to API documentation - Recording from Los Angeles API documentation workshop
In January I gave an API documentation workshop in Los Angeles, and I recorded the first section of the workshop. This section provides an introduction to APIs, including an overview of APIs, the API doc market, info about API popularity, how to submit requests through Postman, and other trends. The recording is available as both a video/audio or standalone audio.
Is there a place for exploratory writing in the workplace?
In a recent episode of The Manuscript, a new podcast by Breno Barreto, Breno asked me questions about blogging and motivations and such. I explained two different modes of writing: explanatory writing versus exploratory writing. Technical documentation is explanatory writing, but many of the posts on my blog are exploratory. Breno asked whether there's a place for exploratory writing in the workplace. This is the great question that every humanities-based or otherwise curious person who is immersed in a corporate world must ask in order to thrive.
Podcast: How Paligo is filling a niche in the CCMS market for complex documentation, with Anders Svensson
I recently chatted with Anders Svensson about how Paligo, a cloud-based CCMS, is filling a niche in the CCMS market for complex documentation needs. Complex documentation refers to documentation with multiple product variants, versions, languages, audiences, and more. In these scenarios, content re-use and scalability become more challenging. Paligo is filling a need for documentation teams that have grown beyond their help authoring tools and need the more robust support that a component content management system (CCMS) offers but without the price tag and implementation timeline.
The Manuscript Podcast, with Breno Barreto -- Episode 2, How technical should a tech writer be?
The Manuscript is a new tech comm podcast produced by Breno Barreto, a technical writer working for VTEX in Brazil. Breno interviewed me for episode 2, titled How technical should a tech writer be? In this podcast, we talked about changes in the tech comm field, how I got started, comparisons with copywriting, API docs, processes for tech writing at Amazon, explanatory writing versus exploratory writing, trends I'm seeing, and more.