'Thanks for the doc, let's set a meeting' (implied: so you can read the doc aloud to us ) is the bane of my existence.
But also, I have a somewhat mentally ill (as in he takes medication for it) coworker that sends rambling extra-long emails, often all one paragraph. If I can't figure out what he's asking by reading the first couple and last couple of sentences I ask him to summarize it with bullet pouts and it actually works. Lol.
This principle applies to the following:
- User documentation
- Specifications
- Code comments
- Any text on a user interface
- Any email longer than one line
Not blog posts or comments. IronicSo if the read of the Miller principle is interpreted as read+understanding (it should) an interesting deeper discussion can happen.
It can be invoked with a way more dramatic "None understands anything"
Anyway, this is just projection. The Miller principle really should be "Miller doesn't read anything". I read plenty.
Good documentation is hard.
I'm a one-man-band so if I write code comments, I write them for future me because up to this point he has been very grateful. Creating API documentation is also easy if you can generate it based on the comments in your code.
Maybe rename it the Filler principle. Nobody reads mindless comments that are 'filler'.
Nowadays everyone can generate a 20-page RFC/ADR and even though you can tell if they are LLM generated, you cannot easily reject them based on that factor only. So here we are spending hours reading something the author spent 5 min. to generate (and barely knows what’s about).
Same goes for documentation, PRs, PRs comments…
"What you have done this week is remind the people of Earth that wonder is worth chasing. That curiosity is the most human thing we have. You didn't just test a spacecraft -- you tested mankind's potential...”