Hacker News new | past | comments | ask | show | jobs | submit login

The classic prof's approach:

1) write a draft. make it correct, but don't worry about good too much yet.

2) teach somebody using the draft. Work with them and watch closely, make notes as you go.

3) revise draft.

4) repeat until good.

With some experience of this practice, you build up a decent model of the student/audience in your head and future first drafts tend to be better.

Also:

1) less is more. Writing less means fewer mistakes and faster reading. Think K&R, not Java for Dummies.

2) lots of examples. Every function description should include at least one realistic example of its use.




Join us for AI Startup School this June 16-17 in San Francisco!

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

Search: