11 ms·
I read an article[0] on HN[1] recently — it talks about the different types of documentation. To quote it directly: "Documentation needs to include and be stru
by ReidZB 7y ago
I read an article[0] on HN[1] recently — it talks about the different types of documentation. To quote it directly:
"Documentation needs to include and be structured around its four different functions: tutorials, how-to guides, explanation and technical reference. Each of them requires a distinct mode of writing. People working with software need these four different kinds of documentation at different times, in different circumstances - so software usually needs them all."
I agreed with its premise — I've found things that only have "story format" docs (i.e. explanation / how-to guides) to be really frustrating. On the other hand, if all that's available is a deep and highly particular technical reference, it's really difficult to get started sometimes.
[0] https://www.divio.com/blog/documentation/ https://www.divio.com/blog/documentation/
[1] https://news.ycombinator.com/item?id=21289832 https://news.ycombinator.com/item?id=21289832
- Wowfunhappy 7y agoWhat is the difference between a tutorial and a how-to guide?
- jwhitlark 7y agoLevel of previous knowledge assumed, tutorials tend to be more "starting from zero", and scope, guides tend to have a narrower focus.
- keithnz 7y agoif you read the link he gave, it has a really good description of each... but to summarize... A tutorial: - is learning-oriented - allows the newcomer to get started - is a lesson A how-to guide: - is goal-oriented - shows how to solve a specific problem - is a series of steps
- Already__Taken 7y agoAnd as an example, Don't list how to install node.js, npm packages and ENV settings in your HAPI server tutorial
- 77544cec 7y agoA tutorial is to an integration test what a how-to guide is to a unit test.
- tartoran 7y agoThink of how tos as recipes for different scenarios