Episode 83: Tools, Technical Writing, & You with Ben Goddard
Dec 20, 2021•1 hr 4 min•Transcript available on Metacast Episode description
Support us on Ko-Fi! (https://ko-fi.com/C0C86NYJW)
Writing elegant code is one thing, but communicating how it works to the wider world is another. This is where technical writers come into the mix and today on the show, we have one in the hot seat! Ben is a technical writer for a company that specializes in remote team collaboration software and he joins us to talk about how he got into the profession, what his workflow looks like, and the kind of value that people like him bring to teams. We hear about Ben’s technical background and how he decided to switch from a troubleshooting role into something more creative and fulfilling. He talks about his favorite tools for note-taking, image editing, writing, and refining his work. We also hear about how he relates with tech teams to learn about a particular product, and what his iterative process of research and writing involves. And if that was not enough, Ben dishes out some great tips for how programmers and technical writers can collaborate more effectively. Today’s conversation also meanders into many other subjects aside from technical writing, so expect to hear the panel’s thoughts on image processing gadgets, Apple versus Staedtler styluses, game programming using Bash, and a whole lot more!
Key Points From This Episode:
Ben introduces himself with the standard greeting in the artificial language Esperanto.
The value of technical writers and Alex and Tessa’s experience working with them.
Ben’s background as a technical troubleshooter and how he got into technical writing.
The procedure followed at Ben’s company to release articles explaining how new products work.
Tools Ben and his company use for note-taking, templating, storing, and publishing.
The favorite tools of Alex, Ben, and Tessa’s for writing, presentations, and more.
How to get the best deal on a Photoshop subscription and which apps are a good alternative.
Different cameras and image processing technology the panel has encountered.
Building things in the most complicated way: CodePen meme templates and Ben’s shell scripts.
Ben’s love of interactive fiction and how he learned if-then logic building MUD games.
How bad the design of the Apple Pencil 1 is and why other styluses are better.
The panel’s knowledge of sentence structure and gendered words in different languages.
Tips from Ben for how programmers can communicate more effectively with technical writers.
More tips from Ben for how programmers without technical writers can create good documentation.
How dev teams without technical writers can advocate for hiring one.
Where to find Ben online.
Tweetables:
“I decided I would maybe not like to troubleshoot things and that it might be fun to teach about technical things, translate technical speak into something that was more digestible.” — @blipsandbleeps (https://twitter.com/blipsandbleeps) [0:04:49]
“I do a lot of writing on gut, at least for first drafts. You know, what sounds correct to say, and then I’ll use a tool to help me make sure that it’s the right sentence structure.” — @blipsandbleeps (https://twitter.com/blipsandbleeps) [0:34:55]
“It’s a fun part of the job to learn about how a thing works. We very much enjoy working with developers and learning about products from their point of view.” — @blipsandbleeps (https://twitter.com/blipsandbleeps) [0:41:42]
“Not everybody needs a technical writer but if you are trying to convey information to as wide an audience as possible it is good to hire somebody who is good with words.” — @blipsandbleeps (https://twitter.com/blipsandbleeps) [0:49:20]
Links Mentioned in Today’s Episode:
Resources:
Bear App (https://bear.app)
Docs to Markdown (https://workspace.google.com/marketplace/app/docs_to_markdown/700168918607) Google Docs extension
StackEdit (https://stackedit.io)
ReadMe (http://readme.com)
Snagit (https://www.techsmith.com/screen-capture.html)
Pixelmator (https://www.pixelmator.com)
Photopea (http://photopea.com)
GIMP (https://www.gimp.org)
Adobe Photography Plan (https://www.adobe.com/creativecloud/photography/compare-plans.html)
Polaroid Now Plus Camera (https://us.polaroid.com/collections/now-plus-3film-bundle)
Game Boy Camera (https://en.wikipedia.org/wiki/Game_Boy_Camera)
CodePen (https://codepen.io)
Bash (https://www.gnu.org/software/bash)
MUD (https://en.wikipedia.org/wiki/MUD)
Ellen Korbes’ photography project (https://twitter.com/ellenkorbes/status/1390411014475292679)
Plus Ergo Grip for Apple Pencil (http://www.plusergogrips.com/pencil)
STAEDTLER’s Noris digital (https://www.staedtler.com/intl/en/discover/noris-digital) stylus
Josh Darnit (https://www.youtube.com/watch?v=cDA3_5982h8), YouTube (dad who follows instructions)
Glass Reflection (https://www.youtube.com/channel/UCmEbe0XH51CI09gm_9Fcn8Q), YouTube
Blender (https://www.blender.org)
Find Ben Goddard online:
Twitter (http://twitter.com/blipsandbleeps)
Picks:
Ben Goddard
TV: What We Do in the Shadows, Season 3 (Hulu (https://www.hulu.com/series/what-we-do-in-the-shadows-0b10c46a-12f0-4357-8a00-547057b49bac))
Movie: Old (TheMovieDb (https://www.themoviedb.org/movie/631843-old?language=en-US))
Comics: Murder Falcon (Image comics (https://imagecomics.com/comics/series/murder-falcon))
Anime: YuruCamp (MyAnimeList (https://myanimelist.net/anime/34798/Yuru_Camp%E2%96%B3))
Book: Wildwood (Goodreads (https://www.goodreads.com/book/show/10431447-wildwood))
Alex
Razer Kishi (https://www.razer.com/mobile-controllers/razer-kishi) game controller
Tessa
The Book You Wish Your Parents Had Read: (And Your Children Will Be Glad That You Did) (https://bookshop.org/books/the-book-you-wish-your-parents-had-read-and-your-children-will-be-glad-that-you-did/9781984879554), Philippa Perry
Jet 90 Complete Cordless Stick Vacuum (https://www.samsung.com/us/home-appliances/vacuums/jet-stick/samsung-jet--90-complete-cordless-stick-vacuum-with-dual-charging-station-and-samsung-clean-station--vs20r9046p3-aa/#benefits), Samsung Special Guest: Ben Goddard.
