We talk about Headless CMS with Simen Svale Skogsrud, Co-founder/CTO of Sanity.io. How to deploy a transcription microservice demo video.
One of our partners has asked if we can help them find a contract API Documentation Writer to document a new payment gateway. You’ll be writing API integration guides that will be used by small to medium sized businesses (a slightly less technical than a developer audience). Like many companies, they like the documentation style… Read more »
Last year, we blogged about creating an API documentation portal using MadCap Flare (see also: Example of API documentation portal using MadCap Flare). Since then, a number of people have contacted us to ask for more details on ways to do this. We’ve put together a video outlining the different approaches and issues. This approach can work with… Read more »
Here are the responses we received when we asked, what are were the common mistakes organisations make with their API documentation: Thinking the auto-generated API reference is sufficient documentation. Shauna Too many docs, not enough code samples. Laura L. Too many “hello world” code samples; Not enough that accomplish something useful. Scott S. Not seeing… Read more »
We’re running another Question of the Week on social media. This week’s question is: What are the common mistakes organisations make with their API documentation? We plan to follow this up at a later stage with suggestions on how to prevent or fix these mistakes. We’ve had some great answers since we posted it in… Read more »