An Engineer’s Field Guide to Great Technical Writing (Ep. 455)

se-stackoverflow

June 21, 2022

We chat with Jared Bhatti and Zachary Sarah Corleissen, two technical writers with deep expertise at main tech corporations and open supply tasks, about their method to documentation and the brand new guide they helped co-author, Doc For Devs.

Avatar for Eira May

We chat with Jared Bhatti and Zachary Sarah Corleissen, two technical writers with deep expertise at main tech corporations and open supply tasks, about their method to documentation and the brand new guide they helped co-author, Doc For Devs. We go deep on the very best methods to annotate a codebase for future generations and localize explainer content material in order that it really works for groups throughout a number of areas and languages.

Episode notes:

Docs for Devs: An Engineer’s Field Guide to Technical Writing could be discovered right here.

Jared labored as a technical author at Google for greater than 14 years and just lately transitioned to Waymo, the self-driving automotive firm spun out beneath the Alphabet umbrella. You will discover him on Twitter and LinkedIn.

Zachary has been a technical author at GitHub and the Linux Basis, and now works as a employees technical author at Stripe. You will discover all his on-line accounts at his website.

All in favour of exploring approaches for collaboration and information administration on engineering groups? Why not attempt a instrument builders already flip to usually? Try Stack Overflow for Teams, utilized by Microsoft, Bloomberg, and plenty of others.

Bored with safety bottlenecks? At this time’s episode is sponsored by Snyk,  a developer safety platform that routinely scans your code, dependencies, containers, and cloud configs — discovering and fixing vulnerabilities in actual time, from the instruments and workflows you already use. Create your free account at snyk.co/stackoverflow.

Tags: docs for devs, documentation, technical writing, the stack overflow podcast

More Posts