The recording for the full-day API workshop that I recently gave in Menlo Park, California, is now available. This recording provides more than 5 hours of instruction about writing API docs -- for fr…
In my Simplifying Complexity series, I added a new post called, Principle 11: Be both a generalist and specialist at the same time. I also recorded this essay as a narrated podcast.
If we just see our task as documenting solutions that engineers have solved, it removes the creativity and critical thinking dimension from tech comm. The creative dimension in tech comm comes into p…
I'm giving a full-day API documentation workshop on Nov 8, 2018, in Menlo Park, California, in coordination with Scott Abel (aka, The Content Wrangler). There are still a few open spots left in the w…
In the debate between being a specialist or generalist, there's also a third option: developing <i>technical acuity</i>. A person with a high degree of technical acuity has the technical mindset need…
When we try to sell our tech comm skills, promoting our <i>writing</i> skills doesn't seem to impress people anymore, as writing is considered more of a presumed skill everyone has. To give a sense o…
Seeing my name in the Census of Technical Communicators survey as a possible source for professional development made me think about the impact of blogs as a learning resource. Advertising encourages…
I added a new article in my ongoing series about simplifying complexity. The article is called <i>Articulating the invisible stories that influence product adoption or rejection</i> and explores why …
In this podcast, I chat with Professor <a href='#kirk_st_amant'>Kirk St. Amant</a> about the relationship between practitioners and academics. Kirk recently co-authored an article about research as a…
I added a new article in my ongoing series about simplifying complexity. The article is called <i>Reducing the complexity of technical language</i> and explores reasons why the language in technical …
This week I chatted with <a href='https://www.linkedin.com/in/docsbydesign/'>Bob Watson</a>, an assistant professor of tech comm at <a href='https://engineering.mercer.edu/academics/undergraduate/tec…
I recently gave a half-day API workshop in Denver on March 10, 2018. Topics in the workshop included how to document reference API content (endpoints, parameters, requests, etc.), what non-reference …
I recently gave a presentation to the STC San Francisco chapter called "Beyond mere endpoint reference — the overlooked content in API documentation" on February 21, 2018. You can browse the slides a…
I recently gave a presentation to the STC San Diego chapter and WTD San Diego group called "Swagger UI and the OpenAPI specification" (February 13, 2018). You can view a recording of the presentation…
I recently gave a presentation called "Publishing tools for API documentation" to the Write the Docs South Bay meetup group on January 18, 2018. You can view a recording of the presentation, browse t…
When you don't have a system that logs users in and tracks their progress, it can be a challenge to show their progress in a course. However, rather than showing progress through completed pages, qui…
I recently gave a presentation titled "Introduction to API Documentation" to the STC Silicon Valley chapter in Santa Clara, California. The video recording and audio are available here.
When documenting REST APIs, the OpenAPI specification (formerly called Swagger) is pretty much the default standard. Yet learning the OpenAPI spec is not a trivial undertaking and requires significan…
Although technical writers champion plain language, embracing plain language for many years can cripple your ability to use more eloquent language, like that of a literary author or essayist. There i…
00:18:07 |
Wed 20 Sep 2017
Disclaimer: The podcast and artwork embedded on this page are the property of Tom Johnson. This content is not affiliated with or endorsed by eachpod.com.