#APIdocs do not have to be boring!

You can enhance how you describe and document the concepts in your #API with cool images 🖼️

If yours is based on #OpenAPI or #AsyncAPI, you can now perfectly size them 📐 on https://bump.sh/

Read how: https://bump.sh/blog/sizing-image-api-documentation?utm_source=mastodon&utm_medium=social&utm_campaign=perfectly-size-images

Correct technical explanation order

https://hilton.org.uk/blog/explanation-order

"Why most writing explains things in the wrong order..."

#api360 #apiDocs

What is an API Product? Design better APIs with a product mindset https://b.mamund.com/3zKhhFh

"We’ll start with the narrower definition and will then extend this to the more general understanding of what an API product is."

#api360 #apiDocs

Write documentation like you develop code https://b.mamund.com/3zHGrEw

"Docs as Code entails writing documentation using the same tools and workflows used for developing code."

#api360 #apiDocs

Bump builds a central hub for all your APIs https://b.mamund.com/3h1OmFY

"Once all the APIs are documented on Bump, whenever there’s a change, Bump can send notifications and highlight changes compared to the previous version."

#api360 #apiDocs

My tech pubs team is currently looking for an experienced & patient technical editor. We are tethered to an office in Ottawa, Ontario, Canada but are once again considering remote candidates. We lost most of the team to pandemic retirements and I have recently rebuilt it, mostly with new engineering grads. Hiring under pandemic conditions was hard. Ramping everybody up is exhausting. I work for a stable, well-established, and well-known Canadian software company. #APIdocs #embedded #writethedocs