The documentation category covers materials produced by the Hack₂O communities. See also Tags & Groups in Get started with Hack₂O Discourse Forum
*We are referring here to an earlier publication that we produced in 2019 (Sens Public online revue, Université de Montréal) [1]. This approach ten to follow Diátaxis [2] systematic approach to technical documentation authoring. It helps to deal with problems relating to the content (what to write), style (how to write it) and architecture (how to organise it) of documentation.
This Documentation is category such as a directory of documentation by type, as follows:
-
The tutorial form tutorial , which focuses on learning, allows the newcomer to get started, like a lesson. It is similar to the act of teaching someone to plant vegetables or to cook.
-
The goal-oriented, how-to guides howto shows how to solve a specific problem, just like a series of steps. It is similar to the act of growing vegetables or a recipe in a cookbook.
-
The explanation type explanation , which focuses on understanding, explains, provides background information and context. It is comparable to an article on the social history of the tomato or culinary social history.
-
The type of reference guide reference, which focuses on information, describes the design carried out. It aims for accuracy, which means checking and adding sources, and seeks to be complete. It is similar to a reference encyclopaedia article
-
docs relates to technical documents retrieved elsewhere that help to describe a procedure, an object, a law, a standard, etc.
Let’s spread the world about our efforts! pages
De l’hypothèse de la documentation comme technique de résistance et du wiki comme objet de ces résistances », 2019, Nicolas Belett Vigneron Émilie Picton Sébastien Beyou Xavier Coadic. in Sens Public. ↩︎
Diátaxis, from the Ancient Greek δῐᾰ́τᾰξῐς: dia (“across”) and taxis (“arrangement”). ↩︎