# ELECTRE Tri-B documentation

by Christian Ghiaus 

Researcher ID: [ORCID](https://orcid.org/0000-0001-5561-1245), [SciProfiles](https://sciprofiles.com/profile/2970335), [Scopus](https://www.scopus.com/authid/detail.uri?authorId=6603390490), [Web of Science](https://www.webofscience.com/wos/author/record/1651371), [HAL](https://cv.hal.science/cghiaus)

[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/cghiaus/ELECTRE_Tri/HEAD)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://github.com/cghiaus/dm4bem_book/blob/main/LICENSE)

![Documentation](../figs/docs.svg)

> Figure 1. Forms of documentation (adapted after [Procida 2017](https://diataxis.fr)).

Documentation is organized according to Diátaxis framework ([Procida 2017](https://diataxis.fr)). The four types of documentation are positioned along two axes that represent different aspects of the user's needs and interaction with the content:
- _cognition_ (theoretical knowledge) vs. _action_ (practical knowledge);
- _acquisition_ (study) vs. _application_ (work).

These axes create four quadrants that define the characteristics of each documentation type (Figure 1):
- __Tutorials__ are structured _learning_ experiences through a series of guided steps to solve a meaningful problem. Users actively engage with the material (_action_) aimed at helping them gain new knowledge and skills (_acquisition_).
- __How-to guides__ provide directions for specific _goals_. Users follow steps to accomplish a task (_action_)
applying existing knowledge to solve particular problems (_application_).
- __Reference__ offers detailed _information_ on functions from Python modules. Users can look for description (_cognition_) in order to apply it to their existing projects (_application_).
- __Explanation__ provides context and deeper _understanding_. Users study explained concepts (_cognition_) helping them gain new insights and knowledge (_acquisition_)

# Bibliography
Procida, D. (2017). Diátaxis documentation framework. URL https://diataxis.fr.
