Search results

What's new

Last updated: Sep 17, 2021

If you’re looking to see what’s new in the API doc site/course, you can browse new content in several ways.

Most recent updates

The following are the most recent updates to the API documentation course.

May 2022

January 2022

  • Revised the content in the Metrics and Measurements section as follows:
    • Consolidated the first-level checkliist and second-level checklist into a single checklist.
    • Removed the approach for quantifying each criteria into a score and weighting that score with the criteria’s importance. This approach was something I experimented with but ultimately found that it didn’t work in practice.
    • Added a lightweight version of the checklist that includes only two criteria from each category.

December 2021

November 2021

October 2021

Using Oxygen XML with docs-as-code workflows. Added a new article in the publishing tools section using Oxygen XML.

August 2021

Auto-generated list of updated pages

This list is auto-generated based on the last-modified timestamp on pages, scoped to the last 60 days. How does the script work? Every page has a “Last updated” line below the title. This script looks for any pages with a timestamp that appears within the last 60 days.

Seeing what content has been updated

To see what’s been updated on the page, click the GitHub button next to the timestamp on the page:

GitHub button

This takes you to the file in GitHub. In GitHub, click the History link:

GitHub History

Then click the commit IDs to browse file diffs for the commits that include the file:

GitHub commit IDs

You can see the stream of commits in GitHub here.

Sponsored content

Recent blog posts about API doc site updates

On my blog, I often write announcement-style posts after adding new content on my API course. I tag these with “api-doc” — you can browse these API doc site updates here.

Buy me a coffeeBuy me a coffee
Stay updated
Keep current with the latest trends in technical communication by subscribing to the I'd Rather Be Writing newsletter. 6,100+ subscribers. (See email archive here.)

3% Complete

3/162 pages complete. Only 159 more pages to go.