3 ms·
Writing is very important. My partner has worked at two of the FAANGs and often times could not understand what anyone was even trying to say. Surprisingly th
by robotburrito 5y ago
Writing is very important. My partner has worked at two of the FAANGs and often times could not understand what anyone was even trying to say. Surprisingly the smartest people in the world are also amongst the worst writers in the world.
My only advice, and I am by no means perfect... Is to use bullet points!
- notacoward 5y agoBullet points have their place, and I certainly use plenty of them myself, but I'm not sure it's the first piece of advice I'd give. I think my #1 point would be that good technical "writing" is not just writing. The best technical docs I can think of also included good diagrams and tables (not meme pictures), visually distinct example code or commands, footnotes and sidebars to keep the main text uncluttered, etc. You don't have to be a full-out graphical designer, but a little work on making something besides an impenetrable wall of text can go a long way toward making a document more readable.