Philosophie de la documentation

De MoodleDocs
Aller à :navigation, rechercher


  • La Documentation Moodle doit fonctionner comme la base de connaissance centrale et officielle de Moodle
  • Transférez dans la documentation Moodle le contenu des discussions des forums de Moodle en français (par exemple des réponses à des questions, idées, suggestions d'utilisation d'une fonctionnalité)
  • La documentation doit être générique et ne doit pas faire référence à des éléments propres à une situation personnelle ou institutionnelle spécifique. De tels éléments peuvent cependant être ajoutés comme liens vers des documents externes
  • Encouragez les nouveaux utilisateurs à contribuer à Moodle Docs :
« Les nouveaux utilisateurs sont les personnes idéales pour écrire la documentation au niveau global du système, destinée à d'autres nouveaux utilisateurs. Ils ont en effet dans l'utilisation du logiciel un point de vue et une expérience au niveau global du système et non au niveau de ses composants. La preuve la plus évidente de ce fait est l'existence de FAQs, dans lesquelles on répond aux problèmes les plus fréquemment soulevés dans les listes de discussions et les chats.» Traduit et adapté de : Documentation issues in open source
  • Encouragez les utilisateurs chevronnés de Moodle en français à contribuer à la documentation Moodle en ajoutant du contenu en réponse à une question dans les forums, et à fournir ensuite un lien vers la page de Moodle Docs correspondante dans la discussion du forum
  • Insérez dans la documentation Moodle des liens Voir aussi vers des informations supplémentaires de Moodle en français, par exemple des forums (mais si la discussion converge vers une conclusion, celle-ci devrait être transférée sur la documentation)