3 ms·
Bullet 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 b
by notacoward 5y ago
Bullet 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.