Correct technical explanation order
https://hilton.org.uk/blog/explanation-order
"Why most writing explains things in the wrong order..."
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."
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."
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."
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
#apidocs #embedded #writethedocs