Hacker News: lornajane

Patterns in Confusing Explanations (2021)

lornajane — Fri, 14 Feb 2025 14:59:27 +0000

Article URL: https://jvns.ca/blog/confusing-explanations/

Comments URL: https://news.ycombinator.com/item?id=43048975

Points: 1

# Comments: 0

New comment by lornajane in "Show HN: Transform Your Codebase into a Single Markdown Doc for Feeding into AI"

lornajane — Fri, 14 Feb 2025 14:56:34 +0000

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)

User Experience, CLIs, and Breaking the World – By John Starich – UX Collective

lornajane — Mon, 18 Dec 2023 10:35:51 +0000

Article URL: https://uxdesign.cc/user-experience-clis-and-breaking-the-world-baed8709244f?gi=a7799300685f

Comments URL: https://news.ycombinator.com/item?id=38680989

Points: 1

# Comments: 0

Better docs, less pain: the case for new docs-as-code standards

lornajane — Fri, 08 Dec 2023 15:13:30 +0000

Article URL: https://passo.uno/docs-as-code-tools-open-standards/

Comments URL: https://news.ycombinator.com/item?id=38569979

Points: 3

# Comments: 0

Best Practices for Writing Docs (For Those Who Would Rather Do Anything Else)

lornajane — Sun, 08 Oct 2023 19:44:00 +0000

Article URL: https://www.grammarly.com/blog/developer/10-best-practices-writing-documentation/

Comments URL: https://news.ycombinator.com/item?id=37813769

Points: 2

# Comments: 1

New comment by lornajane in "Be careful of the examples you use. They stick"

lornajane — Mon, 21 Aug 2023 13:27:33 +0000

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!

Show HN: Redocly CLI stable release 1.0

lornajane — Wed, 16 Aug 2023 16:55:34 +0000

First (stable) release of Redocly CLI, an open source tool for doing OpenAPI things, like docs, linting, and file management.

Comments URL: https://news.ycombinator.com/item?id=37149934

Points: 2

# Comments: 0

Redocly Brings Enhanced OpenAPI Experience to JetBrains IDE – The JetBrains Blog

lornajane — Tue, 08 Aug 2023 08:41:28 +0000

Article URL: https://blog.jetbrains.com/blog/2023/08/07/redocly-brings-enhanced-openapi-experience-to-jetbrains-ides/

Comments URL: https://news.ycombinator.com/item?id=37046160

Points: 3

# Comments: 0

Reasons Webhooks Are Magic (2013)

lornajane — Sun, 30 Jul 2023 18:13:21 +0000

Article URL: https://blog.iron.io/7-reasons-webhooks-are-magic/

Comments URL: https://news.ycombinator.com/item?id=36934216

Points: 4

# Comments: 0

Reasons Not to Be a Manager (2019)

lornajane — Sun, 30 Jul 2023 18:06:27 +0000

Article URL: https://charity.wtf/2019/09/08/reasons-not-to-be-a-manager/

Comments URL: https://news.ycombinator.com/item?id=36934135

Points: 248

# Comments: 186

New comment by lornajane in "Ask HN: Could you share your personal blog here?"

lornajane — Thu, 06 Jul 2023 09:34:05 +0000

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.

New comment by lornajane in "My Problem with the Four-Document Model"

lornajane — Thu, 06 Jul 2023 08:10:57 +0000

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.