Hacker Newsnew | past | comments | ask | show | jobs | submitlogin

The article is extremely short, but the three points it makes resonate with my experience--but not the title, since I usually end up writing tutorials about subjects I am already quite familiar with but written with a specific audience in mind (my own tech teams in the past, specific customers these days).

Regardless, the points are valid:

1) You will find that you need to clarify what for you are intuitive leaps or gaps in detail so that someone else understands them

2) Peer review and feedback often improves the quality (and reach) of your document

3) Language matters. Regardless of language skill improvements, reach is paramount, and I recall when it was somewhat unpopular to write technical documentation in English in my neck of the woods.

Today that's mostly moot, but something to consider.



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

Search: