Conseils de bon style

Voici quelques conseils sur la façon d’écrire une bonne page de wiki. Utilise la page de discussion pour tes commentaires à ce sujet.

• Commence ta page par une en-tête de premier niveau avec un titre significatif.
• Sépares ton texte en paragraphes en laissant une ligne vide entre eux. Un paragraphe moyen ne devrait pas avoir plus de 10 à 20 lignes.
• Si ton texte fait plus que quelques paragraphes (de 3 à 5), coupez-le en sections en ajoutant des entêtes de niveau 2 à 5.
• Quand ton texte fait plus de 2 ou 3 pages d’écran, met un court résumé du contenu de la page après le premier en-tête.
• Si tu as beaucoup de liens vers d’autres pages wiki ou vers des ressources externes, ajoute une section spéciale avec d'autres références (voir ci-dessous).

• Les mots seuls peuvent être mis en évidence soit en les soulignant, soit en les mettant en gras, soit en les écrivant en lettres CAPITALES. Les courts passages de textes peuvent être mis en évidence soit en italique, soit en gras.
• Choisissez un style pour afficher la sortie du texte à l’écran comme des boutons ou des étiquettes de menu et utilise-le uniformément. Ce pourrait être une bonne idée d'ajouter une page avec une explication de tes conventions de styles propres à ton wiki.
• Utilise les listes non triées pour les éléments qui sont indépendants les uns des autres. Si vous développez une explication, écrivez les phrases dans un ordre continu.
• Utilise avec parcimonie les notes de pied de page et seulement pour des remarques complémentaires très courtes. S'il y a beaucoup plus à dire sur un sujet spécifique, met-le sur une nouvelle page du wiki. Si tu veux te référer à d'autres sources d'information (extérieures), utilise plutôt des liens.
• Les tableaux peuvent améliorer considérablement la lisibilité de données structurées. Si tu insère un tableau, assure-toi qu'il ait des en-têtes significatives pour chaque cellule et met une légende qui énonce clairement le contenu du tableau (par exemple “Tableau 1.2 : Distances moyennes entre les planètes”).

• Utilise des phrases bien construites et utilise les articles pour les noms.
• Commence chaque phrase par une majuscule et termine-la avec un point ou toute autre ponctuation appropriée.
• N'utilise pas de langage SMS et évite les anglicismes et les acronymes qui peuvent altérer la compréhension de ton texte.
• Essaye d'écrire court, des phrases claires sans trop avoir recours à des explications de moindre importance. Quand tu penses que tu as terminé ta page, relie-la encore et corrige les phrases qui ont une structure excessivement compliquée.
• Décide de la façon dont tu veux t'adresser au lecteur. Puisque DokuWiki est orienté vers l’écriture de documentation, tu devrais souvent donner des explications aux lecteurs, comment faire certaines choses. Tu peux utiliser la forme impérative (“faites ceci !”), la forme nous/vous (“puis nous/vous cliquons(ez) sur…”) ou la forme je (“j'ajoute alors le point à la barre, en utilisant…”). Ne mélange pas ces formes.
• Avant la sauvegarde examine ta page pour déceler les fautes de grammaire ou d'orthographe. Si ton texte comporte beaucoup d'erreurs, il affaiblira la crédibilité de tes propos, indépendamment de l’intérêt qu’ils peuvent avoir.
• Développe ton propre style. Ne te force pas à écrire avec un style qui ne te convient pas. Il en résulterait un texte artificiel et désagréable à lire.

• Quand tu utilises un terme qui nécessite des explications supplémentaires, ajoutez une nouvelle page au wiki et fait un lien vers elle.
• Vérifie ta page avant de l'enregistrer, ajoute les liens vers les autres pages existantes du wiki pour les termes principaux de la page.
• N'ajoute pas un lien à chaque occurrence d'un terme spécifique. Fait-le sur la première occurrence rencontrée et ajoute éventuellement un lien à la section de référence du terme.
• Si tu ajoutes une ligne “Voir aussi :” à la fin de ta page. Fait des liens uniquement vers les pages du wiki qui sont étroitement liées au sujet de ta page.
• Si tu veux te référer à des ressources externes qui donnent davantage d'informations à ton sujet ou que tu as utilisés en écrivant ta page, ajoute une section appelée “Références” ou “Plus d'informations” et fourni une liste de liens. Indique dans ton lien l’objet du site auquel tu faits référence (par exemple “[site] d’autres conseils sur la reproduction des coccinelles.”).

• “Une image dit plus que mille mots.” Elle peut même dire plus que ce que l’on aurait souhaité. Les humains ont moins tendance à remettre en cause l'authenticité des images que du langage. Une description textuelle courte est meilleure que rien du tout ou qu'une image imprécise.
• Comme pour les tableaux, indique toujours une légende pour les images, qui énonce ce que tu veux montrer avec elle (par exemple “Image 3.2 : Photographie d'amateur montrant la reproduction des coccinelles.”)
• Si tu n’es pas l’auteur de l'image, indique la source (probablement avec un lien) et le copyright.
• Ne lie pas d'images de sites externes, à moins que tu ne sois autorisé à le faire. En effet ceci vole de la largeur de bande au site accueillant l'image. Télécharge plutôt l'image dans le wiki, si tu le peux.
• Si l'image est plus grande que le tiers d'une page d'écran, utilise un lien de redimensionnement pour afficher une vignette.

Page Conseils de bon style revue et corrigée par Chewbacca qui est issue DikuWiki créé par Philippe LAPEYRIE en 2006.