miniblog.

← Back to all posts
Nov 13, 2022 at 04:28
Writing docs like characters in a novel: give people a purpose! https://thenewstack.io/an-engineers-best-tips-for-writing-documentation-devs-love/

Related Posts

Mar 8, 2026 at 22:56
33
Writing type params with <> (e.g. List<Int>) seems the most natural to me: probably because I encountered that syntax first. Between C++, Java and TypeScript I think it's the most common too. List[Int] seems to be next most common (Scala, Python) but TIL Gleam uses List(Int)!
Jan 18, 2026 at 16:46
32
Show, don't tell: effective advice for writing for both LLMs and people!
Prompting 101: Show, don’t tell
Prompting 101: Show, don’t tell
Improve your prompts with better examples rather than better instructions
Jan 16, 2026 at 10:26
26
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?