From The Blog

How to structure and share code examples

Writing for technical audiences often means sharing code in one form or another. If the code is only for illustration purposes, then it can be included in the article for observation. But if the code is useful or reusable by your readers, then you need a way to make it available to them. I’ve seen a few questions on this recently (shout out to the DevRel Collective slack for a brilliant discussion AND nagging me to write it up as a post!), so I’m sharing my experiences on how to publish and maintain code in sane ways! Continue reading

Pretty-print JSON with jq

Wrangling some document conversion the other day, I ended up in a situation where I had the JSON I needed, but in a completely unreadable format. Luckily, this problem is very easily fixable …. when you know how. So today’s post is a quick recap on how I did that using jq, a very handy command-line tool for working with JSON. For the impatient, here’s the command:

cat posts.json | jq "." > better.json

In this post we’ll look at the data I started with and what the different bits of the command to do help. Continue reading

Open Standards for APIs

I work or have worked with APIs of all sorts of standards, sometimes many standards at once – or none. Each standard exists for a purpose and might be a great fit, or a terrible fit for other purposes. Today’s post is a recap of some of the common API standards around and what you need to know about each one. Continue reading

Talks, Articles, Podcasts, and More

Video

API Evangelist Conversation


API Evangelist Conversation, October 2024
Slides

DevOps Your Docs


WriteTheDocs Atlantic, September 2024
Slides

API Description Pipelines


APIDays London, September 2024
Slides

AsyncAPI governance the easy way


APIDays London, September 2024
Slides

Write Great Tech Content


WordCamp Whitley Bay, July 2024
Speaker

Voices from UK Tech


Chinchilla Squeaks, June 2024