Search results

Write the Docs podcast episode 20: Minimum requirements for good tech docs, with Matt Reiner

by Tom Johnson on Mar 3, 2019
categories: writing wtd-podcasts

In episode 20, Matt Reiner from K15t joins us to talk about minimum standards for documentation -- what techniques or standards can you put in place to help engineers and other contributors meet the minimum requirement for good tech docs? What essential sections, headings, or topics should you include in templates? And how do you help non-native speakers with grammar issues? We also discuss how tech writers can work with marketing to create honest and interesting writing. There seems to be the feeling that tech writing is dull but accurate and marketing copy is flashy and fluffy -- we brainstorm ways technical writers can better align with marketing writers.

You can watch the podcast here:

To view the original post, see WTD Episode 20: Minimum requirements for good tech docs, with Matt Reiner.

Links for more information:

About Tom Johnson

Tom Johnson

I'm an API technical writer based in the Seattle area. On this blog, I write about topics related to technical writing and communication — such as software documentation, API documentation, AI, information architecture, content strategy, writing processes, plain language, tech comm careers, and more. Check out my API documentation course if you're looking for more info about documenting APIs. Or see my posts on AI and AI course section for more on the latest in AI and tech comm.

If you're a technical writer and want to keep on top of the latest trends in the tech comm, be sure to subscribe to email updates below. You can also learn more about me or contact me. Finally, note that the opinions I express on my blog are my own points of view, not that of my employer.