Writing docs like characters in a novel: give people a purpose!
https://thenewstack.io/an-engineers-best-tips-for-writing-documentation-devs-love/
miniblog.
Related Posts
Show, don't tell: effective advice for writing for both LLMs and people!
I see people advocating for writing a FAQ, but I really struggle to write one from scratch.
The best FAQs are written as a response to, well, frequent questions.
How do you populate the initial FAQ?
I've been learning some Common Lisp by writing some simple JSON munging programs. I'm sure it's not best practice — I should probably deserialise to CLOS automatically — but it's a nice way to get comfortable with the basics.
It feels weird deliberately ignoring helpers though.
