lornajane

Joined 12 years ago

Karma
132
Submissions
51
Member since
Oct 13
Lorna writes code and words
View on Hacker News

Recent submissions

Comment · 1 year ago
For extra points, compile your docs into one file and feed it that as well.

(unless the reason you're giving AI the code is that you don't have any docs for either humans or machines)

Comment · 3 years ago
This is such a great story and an important one. I always optimise examples for people copying and pasting, trying to make it as safe and meaningful by default as possible. It doesn't matter why you're copying and pasting - you may not have a lot of skills in this specific area, or you might be in a hurry. If you know what you're doing, you can probably improve the code, but if you use it as-is, it shouldn't come back to bite you!
Comment · 3 years ago
https://lornajane.net

Over a thousand posts (I've been doing this a while apparently) on APIs, open source, backend scripting languages, developer experience/relations, other random tech, and the occasional recipe.

Comment · 3 years ago
This article picks up some good points, but it seems like the main criticism is that Diataxis isn't useful for a programming language because that requires a sequence of lessons. But docs aren't a textbook, if you want to create a learning resource that's great - but that's not documentation IMO.

Live from the official Hacker News API

A modern reader for Hacker News · SvelteKit + Skeleton