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: API documentation
You can use MadCap Flare to create static site HTML knowledge bases and developer portals. In this video, we show how you can import an OpenAPI/Swagger API reference file, by using the new Markdown import feature. The benefit is that all of your content can have the same “look and feel”.
We’ve created a free mini-course containing three short videos, best practice examples, and resources. To access the course, click on either the link or the image below: What developers want from a developer portal and API documentation…and how to provide it
(Updated description) A client of ours has a requirement for a contract Technical Writer based in the UK. It’s a 6-12 month contact working for a government department. The role involves documenting internal tools for end users, and providing technical documentation for developers. It’s similar to the [GDS Technical Writer role](https://www.gov.uk/guidance/technical-writer). This includes: Using GitHub… Read more »
A software company, involved in blockchain/Fintech security infrastructure, is looking for a writer to update its API documentation. Initially it would be 2-3 weeks work, but they want someone they can rely on a long term basis as there’s likely to be follow-on work in the future. The initial work is adding some new API… Read more »