4 ms·
Related to this: understanding the various types of documentation, and using them all appropriately. I highly recommend Daniele Procida's talk about this, [0]
by MaxBarraclough 6y ago
Related to this: understanding the various types of documentation, and using them all appropriately.
I highly recommend Daniele Procida's talk about this, [0] and the accompanying web page [1]. He gives a useful taxonomy of the 4 kinds of documentation. Through the power of Unicode:
┌──────────────────────────┬─────────────────────────┐ /\
│ Tutorials │ How-to Guide │ || Practical
│ (Learning-oriented) │ (Problem-oriented) │ ||
├──────────────────────────┼─────────────────────────┤
│ Discussions │ Reference │ ||
│ (Understanding-oriented) │ (Information-oriented) │ || Theoretical
└──────────────────────────┴─────────────────────────┘ \/
<=== Useful for study Useful for coding ===>
[0] https://youtu.be/t4vKPhjcMZg?t=160 https://youtu.be/t4vKPhjcMZg?t=160 (that will take you to the start of the talk proper)
[1] https://documentation.divio.com/ https://documentation.divio.com/
edit Didn't spot the link to [1] at the bottom of the article :P
- moosebear847 6y agoNot a bad thing to surface good things multiple times :>