API Documentation: A Guide for Technical Writers & IT Professionals
About this episode
Welcome to episode 076 of the Technical Writing Success podcast from the Curt Robbins & Associates Technical Writing Agency.
This podcast is targeted at IT professionals, technical writers, and documentation specialists. Subscribe today to never miss a single daily episode!
Today’s episode teaches listeners about API documentation, including the most popular development tools, what to do to achieve success with API docs, and what to avoid.
Hosts Daphne and Fred share their spirited analysis of the recent article by Curt Robbins entitled "API Documentation: A Guide for Technical Writers & IT Professionals." They explore the history of API documentation, the elements of quality API docs, and the things that should be strategically avoided to ensure success. They also discuss API doc tools such as Doxygen, Markdown, GitBook, Postman, Readme, and Swagger.
The Curt Robbins & Associates Technical Writing Agency is currently taking on new clients. We enjoy helping companies with their documentation and communications strategy and implementation. Contact us to learn about our reasonable rates and fast turnaround.
Read the original article by Curt Robbins: https://tinyurl.com/2uackzhh.
Read Robbins' article "The Eight Pillars of Technical Writing": https://tinyurl.com/vm35fnsm.
Get every episode summarized
Each time Technical Writing Success publishes, we email you a written briefing from the transcript — the topics, who appeared, and any specific claims, with the ad reads skipped.
Email me new episodesFree for 3 shows. No card needed.
Hosts & guests
No transcript yet
This episode has not been transcribed. Request it and it moves to the front of the queue.
More episodes
More from Technical Writing Success
A Fond Farewell—and Where to Find Us Next
Technical Writing Success
Context Engineering: The AI Skill That Outlasts Any Job Title
Technical Writing Success
Does llms.txt Actually Work? An Honest Look for Technical Writers
Technical Writing Success
What Technical Writers Should Automate First (A Practical Playbook)
Technical Writing Success