EPISODE · Dec 4, 2024 · 14 MIN
API Documentation: A Guide for Technical Writers & IT Professionals
from Technical Writing Success · host Curt Robbins
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.
What this episode covers
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.
NOW PLAYING
API Documentation: A Guide for Technical Writers & IT Professionals
No transcript for this episode yet
Similar Episodes
No similar episodes found.
Similar Podcasts
No similar podcasts found.