Vacancy: #4192 Contract API Technical Author, Central London, 4 months

Revised description: Our client is looking for a Technical Author to help them create a developer portal that will  support the organisations that use their APIs and SDKs. You will help them develop the documentation: API reference documentation Ideally, the SDK documentation The SDKs are used by their partners to build mobile apps written in… Read more »

Vacancy – #4189 Contract API Documentation Writer, London

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 »

Importing API reference documentation into a MadCap Flare project

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 »

Common mistakes organisations make with their API documentation

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 »