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”. Here is screenshot… Read more »
Tag: API documentation
What developers want from a developer portal and API documentation
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
Vacancy #4197 Contract API Technical Author, 6-12 Months
(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 »
Vacancy: #4198 Contract Technical Author, API documentation, Work From Home
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 »
What people said were the common mistakes organisations make with their API documentation
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 »