Archive - Ask me about API docs

Don't miss these: The best writing from API Futures

I’ve been studying up on the writing in API Futures this week.

Jan 13, 2024 •

Clarence W Cromwell

The future of APIs is about user experience

And how documentation can make a decisive contribution in the user experience

Jan 8, 2024 •

Clarence W Cromwell

August 2023

My take-aways after diving into toolchains

Docs as Code is indeed the best tool for many situations, but there are other tools and other situations.

Aug 14, 2023 •

Clarence W Cromwell

Toolchains have families

Have you used the five most common types?

Aug 7, 2023 •

Clarence W Cromwell

July 2023

Anne Gentle: 'How do you keep your authors happy but also make sure your customer gets what they need?'

Anne Gentle has seen numerous changes in the documentation world since she wrote the first edition of “DOCS LIKE CODE.” She’s also made some…

Jul 11, 2023 •

Clarence W Cromwell

June 2023

When docs as code is a big success, this is why

There are situations where the Docs as Code approach is unarguably the best.

Jun 24, 2023 •

Clarence W Cromwell

November 2022

A definition for docs as code

The more questions I ask, the more it seems that people have slightly different ideas about the definition of the term "Docs as code."

Nov 25, 2022 •

Clarence W Cromwell

September 2022

Knowing the requirements first prevents toolchain misery later

Documentation tools have to fit the circumstances where they're being used, and every company's circumstances are unique.

Sep 29, 2022 •

Clarence W Cromwell

August 2022

The trouble began when they changed the documentation tools

Everyone's thinking about new tools -- but why?

Aug 31, 2022 •

Clarence W Cromwell

Have you read these?

While I’m digging into toolchain research, here are some useful articles that I’ve been meaning to share from my public site.

Aug 14, 2022 •

Clarence W Cromwell

The cheat sheet for writing Swagger descriptions

OAS3 specs are full of things that need descriptions. Here are some tips for writing them. Always start with the action word. Use the action + object …

Aug 6, 2022 •

Clarence W Cromwell

July 2022

Test driving the documentation

One of the most effective practices I've found for documentation is something I call test-driving.

Jul 23, 2022 •

Clarence W Cromwell

#nojs-banner { position: fixed; bottom: 0; left: 0; padding: 16px 16px 16px 32px; width: 100%; box-sizing: border-box; background: red; color: white; font-family: -apple-system, "Segoe UI", Roboto, Helvetica, Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji", "Segoe UI Symbol"; font-size: 13px; line-height: 13px; } #nojs-banner a { color: inherit; text-decoration: underline; } This site requires JavaScript to run correctly. Please turn on JavaScript or unblock scripts