Words To Avoid in Educational Writing | CSS-Tricks
I'm no English major, but as a writer and consumer of loads of educational (mostly tech) writing, I've come to notice a number of words and phrases that come
What is Developer Experience? a roundup of links and goodness
I recently contributed to a series of fireside chats hosted by LaunchDarkly. One of the themes that we discussed was Developer Experience, and how to improve it. I was asked by one of the attendees at the EMEA event (video here, interview by Cody De Arkland) about further reading on the subject and offered to
The Business Case for Developer Experience - Caseysoftware
While I’ve made a case for Developer Experience (DevEx) – aptly named The Case for a Great Developer Experience – I realized it was making the case to other developers. Obviously developers understand that better docs, a good design, and useful examples make a product easier to use. But how do we quantify that? How […]
The Developer Experience organization at Netlify is quite unique. In this post, we talk through the structure of the organization, how we work, who we are, and some of our team strategies.
How To Build And Enforce Great API Governance | Nordic APIs |
In the world of web APIs, the need for governance and shared standards increases as a business seriously considers its data value and platform strategy.
Why is @stripe's API so good?Teams debate the naming of each field, talk about trade-offs, and attempt to plan ahead for new features that may change the shape of the API.We *take the time* to get it right, and individual engineers recognize the best design requires teamwork.— Zach Tratar (@zachtratar) February 21, 2020
Ben Nadel thinks about all of the changes that you can make in an API which could be considered a "breaking change" for a consumer. Depending on how hard you squint, the breadth of breaking changes can be quite a bit larger than we usually think it is.
The problem with Frequently Asked Questions (FAQs) in documentation
Many tech writers have a heavy disdain for Frequently Asked Questions (FAQs) in documentation. At first this disdain seemed a bit unfounded and elitist to me, but now, after a recent project, I'm starting to understand the reasons for the disdain. All too often the FAQ format is abused by non-writers who want an easy way to write. The list of random questions grows with each incoming question until it's a ridiculous hodgepodge of information thrown together, with no larger story or narrative.
This post is a write up of a talk given at DevRelCon Tokyo 2017 and a few other events. Slides for this talk are available on Speaker Deck. Prologue We all occasionally have one of these days where...