For AI agents: a documentation index is available at https://idratherbewriting.com/llms.txt. Markdown versions of all pages are available by appending .md to any page URL.

Search results

Webinar recording of 'Using MadCap Flare to Generate API Documentation'

by Tom Johnson on Feb 2, 2022
categories: technical-writing

'Using MadCap Flare to Generate API Documentation' provides an excellent introduction to API documentation, along with an example implementation in Flare. This webinar, hosted by MadCap Software, was presented by Athena Adiksson and Jana Cromer of VAS. The webinar focuses on the basics of API documentation content, not necessarily on OpenAPI specifications or integration. VAS provides a farm management API. You can view the recording here. (Note that MadCap Software is one of the sponsors of my site.)

Sponsored

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, agent skills, tech comm careers, and more. Check out my AI courses for more on the latest in AI and tech comm. If you're looking for info about documenting APIs, see my API documentation course.

If you're a technical writer and want to keep on top of the latest trends in tech comm, be sure to subscribe to email updates below. You can also learn more about me or contact me.

Finally, I want to note a couple of things. I usually write the first drafts of my posts myself and then use AI to improve accuracy, clarity, and detail in places, so my writing is a mix of human and AI. (Hopefully that's not too off-putting.) Also, the opinions I express on my blog are my own perspectives, not those of my employer.