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

Over at his Computer Things newsletter[1], Hillel Wayne offers up some additional kinds of documentation worth adding to the four-document model. He lists five, but goes into detail on two: Conceptual Overviews are intended for beginners. They walk through all the concepts at a very high level. They provide no guide on “how,” avoid jargon, and can be understood by outsiders. Case Studies are examples that explore interesting or complicated problems in applying the concepts documented. An example is intentionally simplified, sometimes toy problems. A case study will show how to use the concepts on problems taken from real world uses.

1 https://buttondown.email/hillelwayne/archive/beyond-the-four...




Consider applying for YC's Spring batch! Applications are open till Feb 11.

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

Search: