Video Audio Listen to this post: You can download the MP3 file, subscribe in iTunes, or listen with Stitcher. Slides My slides are here: idratherbewriting.com/intro-to-api-documentation. Presentation details To view more details about the API doc presenta

Listen to this post: You can download the MP3 file, subscribe in iTunes, or listen with Stitcher. A world standard for describing REST APIs Smartbear recently announced support for new OpenAPI 3.0 version of the spec in SwaggerHub. The 3.0 version of the

Listen to this post: You can download the MP3 file, subscribe in iTunes, or listen with Stitcher. Simple versus complex language My wife is in a master of liberal arts program at Stanford. When she writes an essay, she asks me to read it and provide feed

Listen to this post: You can download the MP3 file, subscribe in iTunes, or listen with Stitcher. Background To provide a little background, at my work we are developing a system to build our Jekyll outputs from a build management system directly into a

Listen to this post: You can download the MP3 file, subscribe in iTunes, or listen with Stitcher. For an introduction and tour of Stack Overflow’s documentation, see Welcome to Stack Overflow Documentation. For their sunset announcement, see Sunsetting D

Note: This is Part 1 in a two part series. Part 2 is available here: Tech docs and Agile Part 2: Alternatives to integrating into engineering Scrums. Listen to this post: You can download the MP3 file, subscribe in iTunes, or listen with Stitcher. Exclus

Note: This is Part 2 in a two part series. Part 1 is available here: Tech docs and Agile Part 1: Problems with integrating tech writers into engineering Scrum teams. Listen to this post: You can download the MP3 file, subscribe in iTunes, or listen with

Listen to this post: You can download the MP3 file, subscribe in iTunes, or listen with Stitcher. Introduction In my previous post, When the pain of ignorance exceeds the pain of learning, I argued that users turn to docs only when the pain of not readin

Listen to this post: You can download the MP3 file, subscribe in iTunes, or listen with Stitcher. Background story The other morning I was trying to upload and share a simple file in a new collaborative file sharing system when I ran into some permission

Listen to this post: You can download the MP3 file, subscribe in iTunes, or listen with Stitcher. Sample scenario with documentation and transparency Scenarios in which marketing or product managers ask tech writers to filter information out of docs aren