Bienvenue !
documente-marcel
est un repo pour apprendre une nouvelle manière de documenter.
Philosophie et inspiration
Comme l’a dit Charles Data Gaulle, dans Le fil de l’API
“Documentation brisée. Documentation martyrisée, mais documentation, documentation libérée”
Documenter, c’est difficile. Documenter, ça intéresse peu. Mais sans documentation, on fait finalement peu de choses dans le monde de la donnée :
- Sans documentation, on ne peut pas gouverner des données
- Sans documentation, on ne peut pas créer et maintenir des données
- Sans documentation, on ne peut pas savoir d’où vient la donnée et où elle va
- Sans documentation, on ne peut pas intégrer fiablement de nouvelles technologies au-dessus des données, comme l’Intelligence Artificielle, cette technologie underground, mais qui va très certainement être à la mode, un jour, peut être.
Qu’est-ce que documente-marcel
?
Au-delà de vous apprendre quelque chose de nouveau, documente-marcel
a vocation à être un socle, un framework pour construire des systèmes de documentation intelligent.
Une définition d’un système de documentation intelligent :
- un système dans lequel le coût cognitif de la documentation a été minimalisé (il faut que documenter soit le plus facile possible)
- un système dans lequel on laisse une part de liberté à
marcel
, le “documenteur” (néologisme à défaut d’avoir trouvé mieux) dans le contenu de la documentation…
- …mais un système dans lequel la documentation de
marcel
s’intègre dans une structure globale, de manière à ce que la documentation de marcel
puisse dialoguer avec celle de michel
, et avec celle de noel
, etc.
- un système dans lequel la documentation est donc fédérée. Pas centralisée, pas partagée, mais fédérée. Une forme de “un pour tous et tous pour un” du XXIème siècle si vous voulez.
- Vous pouvez rejoindre le club Marcel : je veux oui ! nom d’un fripon !
- Pour comprendre Marcel : je veux pas lire Proust, mais Marcel pourquoi pas