A nine-point strategy for developing a successful API documentation portal

Below is a strategy for developing a successful API documentation portal. By following these steps, you can create a plan for building a documentation portal that meets the needs of your API users, and supports the goals of your organisation. Overview of the steps Step One: Determine your audience For example, you need to know:… Read more »

Vacancy: #4528 Contract Technical Writer WFH/London

A UK government department is looking to recruit an additional contract technical writer to create and manage technical documentation for service teams, and to document its decisions and how things work. They need someone who will: Write technical documentation for internal users and government services, including API documentation and technical guidance Understand GOV.UK style and… Read more »

Freelance API Specification File Writer. UK

We’ve had an enquiry from a fintech prospect who is looking for a contractor to improve their approx 40 API specification files. They want to improve the naming conventions and consistency across the APIs. They also want them to be Restful. You need to be based in the UK or mainland Europe. Contact us if… Read more »

Vacancy: #4525 Contract Technical Writer WFH/London

A UK government department is looking to recruit a contract technical writer to create and manage technical documentation for service teams, and to document its decisions and how things work. They need someone who will: Write technical documentation for internal users and government services, including API documentation and technical guidance Understand GOV.UK style and write… Read more »

Podcast 118: What’s up Redocly?

Cherryleaf’s Ginny Critcher and Ellis Pratt discuss using the Redocly platform to create a developer portal and API documentation. More information: Redocly What is your developer portal’s KPI score? Transcript Audio file  redocly-final.mp3    Transcript  Speaker 2 This is the Cherryleaf podcast.  Speaker 3  Hi everybody, welcome to the Cherryleaf podcast. I’m Ginny Critcher and… Read more »