Hacker Newsnew | past | comments | ask | show | jobs | submit | Keinstein's commentslogin

Do you have any tips on getting better at this (eg writing explanatory pieces on technical issues) apart from simply doing it over and over again?


Harsh, brutal critique from other people (ideally the target audience), prompted by deliberate questions from us about how easy it is to read and understand, and questions from us to test that understanding.

Writing happens entirely inside one's own mind; it can be so hard to see that what we're writing isn't clear, isn't well structured, doesn't guide the reader deftly through understanding and enlightenment. I wonder if it's even possible to properly critique our own explanatory pieces on technical issues, given that we cannot read it without having that knowledge already in our heads, as the target audience will have to.

It can be quite a shock to learn how badly written some of our own work is; as with code reviews, ego has to step aside.


I really enjoyed "The Sense of Style" by Steven Pinker. It's meant to be an accessible guide for the common writer.

(I have an English degree, so I can at least say his advice rings true and hits a lot of important points.)


Guidelines | FAQ | Lists | API | Security | Legal | Apply to YC | Contact

Search: