logoalt Hacker News

throwaway219450today at 4:04 AM0 repliesview on HN

> Technical documentation, where what the reader wants to come away with is the clear facts on what something does and how to use it/whatever, is a different matter.

I don’t agree with this one. Writing technical documentation can be a slog, but quite often you will discover very annoying design decisions in the process. Like you’ll write a tutorial for a CLI and realize that actually some flag makes no sense, or some default should be changed.

This also goes for dogfooding. If you’re using AI to write and run the tools, try to use them yourself and see how nice they are. AI will happily run whatever jank it’s working with.

Docstrings perhaps, but even then I find myself editing heavily to avoid cruft sneaking in.