askmeaboutAPIs's profile picture. Technical writing; API docs; toolchains; Swagger.

ccromwell

@askmeaboutAPIs

Technical writing; API docs; toolchains; Swagger.

ccromwell reposted

We invite you to a full-day online conference in April 2024, where we welcome thought leaders and all providers to show their #LLM tools, explain their solutions, and explore real market needs. The Call For Speakers is open till the end of January! apithedocs.org/ai-2024

APItheDocs's tweet image. We invite you to a full-day online conference in April 2024, where we welcome thought leaders and all providers to show their #LLM tools, explain their solutions, and explore real market needs. 

The Call For Speakers is open till the end of January!
apithedocs.org/ai-2024

Anne Gentle: 'How do you keep your authors happy but also make sure your customer gets what they need?' askmeaboutapis.substack.com/p/anne-gentle-…


Ask me about API docs: A definition for docs as code askmeaboutapis.substack.com/p/a-definition…


Knowing the requirements first prevents toolchain misery later on Ask me about API docs askmeaboutapis.substack.com/p/knowing-the-…


The trouble began when they changed the documentation tools on Ask me about API docs askmeaboutapis.substack.com/p/the-trouble-…


ccromwell reposted

Does anyone know the origin of the term "docs as code" or what popularized it? I feel like it's been around for 4-5 years, but I don't have a great sense for where it originally came from, or if it just came from ether since it is mostly descriptive? #writethedocs #techcomm


ccromwell reposted

Here's my explanation of an open API vs OpenAPI

The @getpostman Open Technologies team (especially @PetuniaGray & @kinlane 🙌) challenged me to explain @OpenApiSpec in 60 seconds. Now it's your turn, explain #openapi and/or how you use it in 60 seconds! #api #apidesign #apigovernance



ccromwell reposted

➡️ So many APIs have documentation that is hard to use, missing key sections, or is just out-of-date. Don’t let that be yours. Give your docs some ❤️ today! #APIs #WhatsYourStrategy?

apistrategyguy's tweet image. ➡️  So many APIs have documentation that is hard to use,  missing key sections, or is just out-of-date.   

Don’t let that be yours.  Give your docs some ❤️ today!  

#APIs #WhatsYourStrategy?

The cheat sheet for writing Swagger descriptions on Ask me about API docs askmeaboutapis.substack.com/p/the-cheat-sh…


Test driving the documentation on Ask me about API docs askmeaboutapis.substack.com/p/test-driving…


Some best practices for technical documentation on Ask me about API docs askmeaboutapis.substack.com/p/some-best-pr…


In documentation, what you leave out is almost as important as what you put in on Ask me about API docs askmeaboutapis.substack.com/p/in-documenta…


United States Trends

Loading...

Something went wrong.


Something went wrong.