API doc site updates
The API doc site updates category lists announcements about new articles that I've added to my API documentation course. The course is something I continue to add to as a way of organizing information about the API doc space.
The following content is in the api-doc-site-updates category:
Moved AI pages into their own collection and space | Jan 20, 2024
New article: AI and APIs: What works, what doesn't | Sep 28, 2023
New API course topic: Using AI for summaries | Sep 7, 2023
New API doc course topic: Using AI for glossary definitions | Sep 4, 2023
New API doc course topic: Using AI for comparison tasks with API responses | Aug 28, 2023
New API doc course topic: Using AI For thematic analysis | Aug 28, 2023
New API doc course topic: Using AI for language advice | Aug 9, 2023
New API doc course topic: Using AI to create doc updates based on bugs | Aug 9, 2023
New API doc course topic: Using AI to learn coding | Jul 25, 2023
New topic in API course: Using AI tools to write build and publish scripts | Jul 19, 2023
New topic in API doc course: AI document engineering with pattern-based prompts | Jul 6, 2023
First Look at Oxygen XML's Positron AI Assistant [API doc course] | Jul 4, 2023
Adding a new AI section to my API doc course | Jul 4, 2023
Chapter PDFs for API doc course | Jun 25, 2023
Blog and API doc course are now one site | Jun 9, 2023
Stoplight tutorial update -- practically every screenshot updated | Nov 1, 2022
Blobr API portal (API doc topic) | Jun 8, 2022
Updated Metrics and Measurement section in API course to remove scoring aspect | Feb 8, 2022
PDF and eBook formats available for API doc course | Dec 29, 2021
Broadcasting your meeting notes (API documentation topic) | Dec 11, 2021
"The writing process"-- a new section in my API doc course | Nov 19, 2021
New article in API doc course: Using Oxygen XML in docs-as-code workflows | Oct 14, 2021
New article in API doc course: 'Ensuring documentation coverage with each software release' | Aug 31, 2021
Sending doc status reports -- a tool for visibility and relationship building [API doc course] | Aug 15, 2021
Updated API Getting Started tutorial | Apr 19, 2021
Updated Stoplight tutorial | Apr 12, 2021
Updated glossary article with technical examples [API doc course] | Mar 18, 2021
10 observations after using my API documentation checklist in a real scenario | Feb 15, 2021
Adding last modified timestamps to content | Feb 15, 2021
Product overviews -- a tricky space where documentation and marketing overlap | Feb 3, 2021
Measuring documentation quality -- a rubric for developer docs | Jan 12, 2021
Finished up the section on documentation processes (for now) | Nov 26, 2020
New API course article: Processes for changing internal doc culture | Nov 26, 2020
New API course article: Processes for external contributors | Nov 26, 2020
Process for collecting feedback post-release (new article in API doc course) | Nov 16, 2020
Processes for maintaining existing documentation (new article in API doc course) | Oct 30, 2020
New article in API course: Processes for reviewing documentation | Sep 23, 2020
Redocly tutorial added to API course | Sep 8, 2020
New article in API course -- Questions to ask during a documentation kickoff and demo | Sep 2, 2020
ISTC article on developer documentation trends | Aug 31, 2020
SDK release process article added to API doc course | Aug 19, 2020
DX content strategy article added to API doc course | Aug 19, 2020
Processes for managing large documentation projects and small documentation requests | Aug 13, 2020
API doc course update: Re-architecting the OpenAPI spec tutorials to start with visual modeling tools first, then code | Apr 28, 2020
Site update: Switched from Disqus to Commento | Jan 30, 2020
Podcast: API Design and Usability with Arnaud Lauret (API Handyman) | Dec 7, 2019
Upcoming API Documentation Workshop in Los Angeles, Calif., on January 23, 2020 | Dec 2, 2019
Reflecting on my latest SF API doc workshop | Dec 2, 2019
Write the Docs Podcast episode 25: Researching how developers use API docs, with Andrew Head | Oct 27, 2019
Expanding embedded Swagger UI instances in your docs | Sep 29, 2019
New topic in API course: Five strategies for documenting code | Aug 8, 2019
New topic in API course: Research on documenting code | Jul 29, 2019
New topic in API course: Why documenting code is so difficult | Jul 29, 2019
If I am learning to write developer documentation, should GraphQL be on my radar? -- guest post by Casey Armstrong | Jul 1, 2019
New video recordings of Raleigh API documentation workshop now available | Apr 21, 2019
Upcoming API workshops in Raleigh (April 6) and Denver (May 5) | Apr 1, 2019
Recording of API documentation workshop in Denver | Mar 12, 2018
Recording of Docs-as-code tools and workflows presentation | Mar 9, 2018
Recording of WTD South Bay presentation: Publishing tools for API documentation | Jan 19, 2018
About 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, plain language, tech comm careers, and more. Check out my API documentation course if you're looking for more info about documenting APIs. Or see my posts on AI and AI course section for more on the latest in AI and tech comm.
If you're a technical writer and want to keep on top of the latest trends in the tech comm, be sure to subscribe to email updates below. You can also learn more about me or contact me. Finally, note that the opinions I express on my blog are my own points of view, not that of my employer.