For a while now, we’ve been looking at ways to import API reference content into MadCap Flare, so that we can use Flare to create a developer portal. Here’s the latest update on what we’ve learnt. Videos: Importing OpenAPI/Swagger API reference content into MadCap Flare 2021 to create a developer portal Importing API reference documentation… Read more »
Tag: APIs
Podcast 105. What are the most common problems organisations make with developer portals and API documentation?
On social media, we asked “what are the most common problems organisations make with developer portals and API documentation?” In this episode of the Cherryleaf Podcast, we look at the responses we received. We also discuss some of the other common mistakes that we’ve come across. Transcript: This is the Cherryleaf podcast. Hello again, welcome to the Cherryleaf podcast… Read more »
Podcast 104: Fixing broken developer portals
On the Cherryleaf Podcast, we look at some of the common content challenges organisations face with their developer portals, and ways to fix them. We also look at creating a friction log, and the complexity of banking related APIs. Transcript: This is the Cherryleaf podcast. Hello and welcome to the Cherryleaf Podcast. We’re going to look at in this… Read more »
New Technical Author vacancies
We’ve added some new vacancies to the Cherryleaf website today: See: #4200 Lead Technical Author, APIs, WFH/Central London, circa £60K #4201 Contract Technical Author, APIs, WFH/Central London
API documentation: the undiscovered country
Recording from UAEurope 2017 conference. With many software developers now spending their time developing APIs, there’s an increasing demand for API documentation writers. It’s a fast changing field, with emerging information design patterns and authoring tools. It’s also different from end user documentation, and this means many Technical Communicators are uncertain if and how they… Read more »