Ask me about API docs
Subscribe
Sign in
Home
Archive
About
New
Top
Discussion
Don't miss these: The best writing from API Futures
I’ve been studying up on the writing in API Futures this week. Here are my recommended reads for technical writers or anyone who cares about APIs. The…
Jan 13
•
Clarence W Cromwell
4
Share this post
Don't miss these: The best writing from API Futures
askmeaboutapis.substack.com
Copy link
Facebook
Email
Note
Other
1
The future of APIs is about user experience
And how documentation can make a decisive contribution in the user experience
Jan 8
•
Clarence W Cromwell
2
Share this post
The future of APIs is about user experience
askmeaboutapis.substack.com
Copy link
Facebook
Email
Note
Other
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. Every tool has an ideal and proper use, and…
Aug 14, 2023
•
Clarence W Cromwell
1
Share this post
My take-aways after diving into toolchains
askmeaboutapis.substack.com
Copy link
Facebook
Email
Note
Other
Toolchains have families
Have you used the five most common types?
Aug 7, 2023
•
Clarence W Cromwell
Share this post
Toolchains have families
askmeaboutapis.substack.com
Copy link
Facebook
Email
Note
Other
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
Share this post
Anne Gentle: 'How do you keep your authors happy but also make sure your customer gets what they need?'
askmeaboutapis.substack.com
Copy link
Facebook
Email
Note
Other
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. The primary example is when engineers maintain an OpenAPI spec that becomes…
Jun 24, 2023
•
Clarence W Cromwell
Share this post
When docs as code is a big success, this is why
askmeaboutapis.substack.com
Copy link
Facebook
Email
Note
Other
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." Here's one…
Nov 25, 2022
•
Clarence W Cromwell
1
Share this post
A definition for docs as code
askmeaboutapis.substack.com
Copy link
Facebook
Email
Note
Other
3
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. I talked with a handful of…
Sep 29, 2022
•
Clarence W Cromwell
Share this post
Knowing the requirements first prevents toolchain misery later
askmeaboutapis.substack.com
Copy link
Facebook
Email
Note
Other
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
Share this post
The trouble began when they changed the documentation tools
askmeaboutapis.substack.com
Copy link
Facebook
Email
Note
Other
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. Minimum viable…
Aug 14, 2022
•
Clarence W Cromwell
1
Share this post
Have you read these?
askmeaboutapis.substack.com
Copy link
Facebook
Email
Note
Other
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
Share this post
The cheat sheet for writing Swagger descriptions
askmeaboutapis.substack.com
Copy link
Facebook
Email
Note
Other
July 2022
Test driving the documentation
One of the most effective practices I've found for documentation is something I call test-driving. A test drive is when you follow the steps yourself in…
Jul 23, 2022
•
Clarence W Cromwell
Share this post
Test driving the documentation
askmeaboutapis.substack.com
Copy link
Facebook
Email
Note
Other
This site requires JavaScript to run correctly. Please
turn on JavaScript
or unblock scripts