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

Related to this, it is why when writing documentation for something, it can be extremely useful to also list the prerequisites someone needs to pick up the information in the document before them. Possibly with also linking to resources about them, depending on your audience.

Not only that, writing out the list of prerequisites also helps the author write a better document. Because thinking about what knowledge is required serves the same function as thinking about a good unit test does. It makes you stop to consider "the obvious" and sometimes realize you have overlooked something.

Because when you are thinking about these prerequisites, you are likely also thinking about why they are needed and what challenges come with them. This in turn might lead you to revise aspects of the documentation to make them clear as well.



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

Search: