organisation
Organisation de la documentation
Le découpage en section de cette documentation est largement inspiré du modèle de divio:
Résumé rapide :
| Tutoriels | Guides pratiques | Référence | Explication | |
|---|---|---|---|---|
| orientation | apprentissage | un objectif | information | compréhension |
| doit | permettre au nouveau venu de démarrer | montrer comment résoudre un problème spécifique | décrire la machinerie | expliquer |
| forme | une leçon | une série d’étapes | description sèche | explication discursive |
| analogie | enseigner à un petit enfant comment cuisiner | une recette dans un livre de cuisine | un article de référence encyclopédique | un article sur l’histoire sociale culinaire |
Ecriture de la documentation
Cette documentation est écrite en markdown et est générée par Jekyll.
Certaines pages plus dynamiques sont écrites directement en HTML.
Voir le code source sur GitHub.