2 ms·
I think one concept missing from the post is that good writing takes heavy thought on what to remove and not talk about. Beginning developers or writers of tec
by supernova87a 6y ago
I think one concept missing from the post is that good writing takes heavy thought on what to remove and not talk about.
Beginning developers or writers of technical information often just transcribe and document everything. In that, the emphasis of the writing is "flat". Everything is equally important. That is lazy thinking.
You encounter this in people doing standup summaries for their teams and just regurgitating everything on their minds, taking up people's time. Usually it means they haven't prepared in advance and thought through what they're going to say.
It takes actual work to distill that to "what things matter to other people?". "What details are important to mention, and not to mention?" Every word included takes away from another word that could be said. Which words are most important?
It takes actual work, understanding of the use cases, and thought, to turn flat documentation into perspective that people find useful. It means often, opinionated editing and writing from a point of view of, what's important (if it is not a pure reference work).
- 6510 6y agoI write enormous walls of text really fast full of examples and detail, I move the sections around until I'm happy. Then I delete about 95% of it and rewrite 10%. I start above the text and eat what is written below while rewriting it. I always look at the end result and think, if only I really was that smart.
- MaxBarraclough 6y agoSounds similar to math. A beautiful compact proof probably didn't start out that way.