workshops:fabacademy2027:documentation
This is an old revision of the document!
Documentation
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.
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 |
References
workshops/fabacademy2027/documentation.1790083041.txt.gz · Last modified: by Julien Deswaef
