Documentation is not easy. Proof is this whole wiki website. It’s a mess of pages half written. Some have useful information at the moment of writing. But few can probably sustain the test of time.

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.

From a presentation by Daniele Procida.

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.

• What nobody tells you about documentation (video)
• The documentation system