Organiser sa documentation
Cette page : Commencer à documenter explique les différentes natures et formats de pages, mais en plus de ces 6 grosses catégories, vous pouvez aussi sous catégoriser le type de contenu.
Explication de la démarche « Expérimentation : typer les documentations des tiers-lieux libres et en source ouverte sur un wiki »
Il existe 4 grandes types de documentation
La forme tutorielle, qui est axée sur l’apprentissage, permet au nouvel arrivant de commencer, telle une leçon. Elle est similaire à l’acte d’apprendre à planter des légumes ou d’apprendre à faire la cuisine à un individu. Exemple : Wikifab. À mettre en haut de page wiki sous forme
. Ce template peut être modifié sur Modèle:Tutoriel
Vous obtiendrez alors un panneau indicatif en introduction de la page dans laquelle vous insérez une indication de typologie.
La forme de guide pratique, qui est axée sur les buts, montre comment résoudre un problème spécifique, tout comme une série d’étapes. Elle est semblable à l’acte de cultiver des légumes ou à une recette dans un livre de cuisine. Exemple : Wiki OpenFarm. À mettre en haut de page wiki sous forme
Vous pouvez partager vos connaissances en l’améliorant (comment ?).
axée sur les buts, montre comment résoudre un problème spécifique, tout comme une série d’étapes.
- Elle est semblable à l’acte de cultiver des légumes ou à une recette dans un livre de cuisine.
- Répertoire : Toutes les pages de ce wiki de type Guide pratique
. Ce template peut être modifié sur Modèle:Guide_pratique
La forme d’explication, qui est axée sur la compréhension, explique, fournit des renseignements généraux et le contexte. Elle est comparable à un article sur l’histoire sociale de la tomate ou l’histoire sociale culinaire. Exemple : Wiki des communs (documentation empirique et théorique). À mettre en haut de page wiki sous forme
Vous pouvez partager vos connaissances en l’améliorant (comment ?).
Axée sur la compréhension, explique, fournit des renseignements généraux et le contexte.
- Elle est comparable à un article sur l’histoire sociale de la tomate ou l’histoire sociale culinaire. Exemple : Wiki des communs (documentation empirique et théorique)
- Répertoire: Toutes les pages de ce wiki de type Explication
Support : Le portail dédié à la documentation et aux codes sources
. Ce template peut être modifié sur Modèle:Explication
La forme d’un guide de référence, qui est axé sur l’information, décrit la conception réalisée. Elle vise l’exactitude, donc la vérification et l’ajout de sources, et recherche à être complète. Elle est semblable à un article d’encyclopédie de référence. Exemple : Wikipedia À mettre en haut de page wiki sous forme
- Elle est semblable à un article d’encyclopédie de référence tel que Wikipedia
- Voir le répertoire des Guides de référence dans Movilab
. Ce template peut être modifié sur Modèle:Guide_de_Référence
Schéma explicatif du Modèle de typologie
Pour une page dont vous considérez qu'elle est sous forme d'ébauche, vous pouvez placer
en haut de page.
Les pages sont ensuite automatiquement répertoriées dans des catégories spécifiques en fonction de leur type
exemple de répertoire créé automatiquement depuis le type « Explication »