Bonnes Pratiques

Même si vous avez une marge de manœuvre pour écrire vos propres livres wiki, il est important de suivre certaines pratiques d'exécution pour assurer que le contenu fourni sur la plateforme Labdoo soit de bonne qualité. En tant qu'écrivain wiki, suivez les recommandations suivantes :

• Faites simple.. Vous avez l'option d'utiliser des tags HTML, mais il est recommandé de ne les utiliser que si vous en avez réellement besoin. Une règle importante est de faire simple pour que soit plus facile à entretenir. Quand il s'agit du wiki, plus c'est simple, mieux c'est.
• Utilisez des liens avec des chemins relatifs. Consultez l'entrée wiki expliquant comment les liens devraient être créés.
• Assurez-vous que les tags HTML sont écrits correctement.Essayez de ne pas en abuser, mais si vous en utilisez pour formater vos pages wiki, assurez-vous qu'ils soient écrits correctement. Tous les tags doivent avoir une clause d'ouverture et de fermeture. Par exemple : <em>text here</em>. Si votre tag ne contient pas d'objets (comme le tag de nouvelle ligne <br> ou le tag de ligne horizontale <hr>), vous avez deux options : soit vous utilisez <br></br> (sans objet entre les clauses) ou la version plus compacte <br/>. Cette première pratique est particulièrement importante parce que le système Labdoo fournit des sauvegardes automatiques de tout le contenu wiki et analyse le script de toutes les pages wiki, si les tags ne sont pas corrects, le processus d'analyse peut se briser.
• En cas de doute, suivez l'exemple de ce livre wiki. Le livre wiki que vous lisez actuellement est fait en utilisant le même système que vous utilisez pour écrire les vôtres. Par conséquent, en cas de doute pour l'écriture une page, venez sur ce guide et regardez comme il a été écrit. En tant qu'écrivain wiki, vous avez assez de permissions d'utilisateur pour cliquer sur l'onglet "Modifier" se trouvant en haut de chaque page du livre (assurez-vous d'être connecté afin de voir l'onglet "Modifier"), il vous permettra de voir comment a été complété chaque champ.
• Mettez des majuscules aux titres. Mettez des majuscules à la première lettre de chaque mot des titres de pages wiki. Par exemple, le titre de cette page est "Bonnes Pratiques", pas "bonnes pratiques" ni "Bonnes pratiques". Ceci aide à maintenir une certaine cohérence.
• Cohérence. Soyez cohérent tout au long de votre document. Les livres wiki peuvent être écrits de différentes manières et styles, mais lorsque vous décidez faire les choses d'une certaine manière, soyez cohérent dans le reste du document. Cela rendra le texte plus agréable pour les lecteurs.
• Vérifiez l'orthographe et relisez votre texte. Assurez-vous qu'il n'y a pas de fautes d'orthographe ou de grammaire dans votre texte, et relisez-le à plusieurs reprises. Il est fortement recommandé de le faire lire à une autre personne pour vous aider à le corriger, si possible quelqu'un de doué en orthographe et en grammaire. Par exemple, faites en sorte d'avoir un volontaire de votre équipe ou communauté qui pourra vous aider pour cette tâche.
• Enregistrez votre texte fréquemment. Assurez-vous d'enregistrer votre texte fréquemment, ceci garantira le fait que votre travail soit enregistré correctement et que le format soit le bon.