documente-marcel

Logo

Une nouvelle façon de documenter

View the Project on GitHub ArthurSrz/documente-marcel

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 :

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 :

Comment utiliser documente-marcel ?

  1. Vous pouvez rejoindre le club Marcel : je veux oui ! nom d’un fripon !
  2. Pour comprendre Marcel : je veux pas lire Proust, mais Marcel pourquoi pas