Differences

This shows you the differences between two versions of the page.

--- workshops:fabacademy2027:documentation [2026/09/21 14:35] – created Julien Deswaef
+++ workshops:fabacademy2027:documentation [2026/09/22 15:22] (current) – [References] Julien Deswaef
@@ Line 5: / Line 5: @@
 In order to better prepare my time at the [[..:|Fab Academy]], I’ve started collecting information about how to properly document things. Hopefully to reach a point where I have a proper template for the whole 5 month course.
-## References
+### How documentation should be split
+From a presentation by Daniele Procida.
+| **Tutorials**\\ Learning-oriented | **How-to Guides**\\ Problem-oriented |
+| **Explanation**\\ Understanding-oriented | **Reference**\\ (Technical) Information-oriented |
+It’s my understanding that if I’m going to document my projects at Fab Academy. Tutorials are out of scope. It’s not my intention to teach people about what I do. My guess is that it’s mostly going to be focused on **Explanation**. I’m not yet sure about the How-to Guides or Reference documentation. That feels also slightly out of focus, except for the final project.
+Reference should be understood as Technical Reference. And not doing article reference as in the practice to refer from where the information comes from.
+## Refs
  - [[https://www.youtube.com/watch?v=t4vKPhjcMZg| What nobody tells you about documentation]] (video)
  - [[https://docs.divio.com/documentation-system/| The documentation system]]