Rédaction et Mise en page

Voici quelques conseils pour rédiger une bonne page wiki.

Cette page est une traduction automatique de : https://www.dokuwiki.org/tips:good_style

Structures de page

Commencez votre page avec un titre de premier niveau avec un titre significatif.
Les niveaux des titres Nest dans leur ordre correct, les sections du deuxième niveau doivent commencer par un titre de deuxième niveau.
Divisez votre texte en paragraphes en laissant une ligne vide entre eux. Un paragraphe moyen ne doit pas dépasser 10 à 20 lignes.
Si votre texte compte plus de quelques (3 à 5) paragraphes, envisagez de le diviser en sections en ajoutant des titres du deuxième au cinquième niveau.
Lorsque votre texte dépasse 2-3 pages d'écran, mettez un court résumé du contenu de la page après le premier titre. Lorsque votre page devient beaucoup plus longue, envisagez de la diviser en plusieurs pages.
Si vous avez de nombreux liens vers d'autres pages wiki ou des ressources externes, ajoutez une section spéciale avec d'autres références (voir ci - dessous ).
Si la plupart des pages d'un espace de noms partagent une structure commune, ajoutez un modèle d'espace de noms afin que toute nouvelle page puisse commencer par cette structure squelette.
Essayez d'éviter les structures d'espace de noms trop compliquées. Essayez d'utiliser des noms d'espaces de noms courts et faciles à retenir.
Envisagez d'utiliser le plug-in de contrôle de la qualité en tant que propriétaire ou contributeur de wiki pour aider à la structure de la page et au formatage du texte.

Mettez l'accent sur des mots isolés ou de courts passages de texte en utilisant des caractères gras ou italiques . Choisissez-en un et tenez-vous-en à votre choix.
Choisissez un style pour représenter la sortie d'écran et le texte à l'écran comme des boutons ou des étiquettes de menu et utilisez-le de manière cohérente. Ce peut être une bonne idée d'ajouter une page avec une explication de vos conventions de style à votre wiki.
Utilisez des listes non ordonnées pour les instructions indépendantes les unes des autres. Si vous développez une ligne de pensée, écrivez dans une séquence continue de phrases.
Utilisez les notes de bas de page avec parcimonie et uniquement pour de très brèves remarques supplémentaires. S'il y a beaucoup plus à dire sur un sujet spécifique, mettez-le sur une nouvelle page wiki. Si vous souhaitez vous référer à d'autres sources d'informations (externes), utilisez plutôt des liens .
Les tableaux peuvent grandement améliorer la lisibilité des données structurées. Si vous insérez un tableau, assurez-vous qu'il a des en-têtes de cellule significatifs et fournissez une légende qui énonce clairement le contenu du tableau (par exemple «Tableau 1.2: Distances moyennes entre les planètes»).
Les grandes tables ont tendance à être très difficiles à modifier. Envisagez plutôt de représenter ses données dans une liste imbriquée.

Écrivez des phrases appropriées et utilisez des articles pour les noms si nécessaire.
Commencez chaque phrase par une majuscule et terminez-la par un point ou une autre ponctuation appropriée.
Essayez d'écrire des phrases courtes et claires sans trop recourir aux clauses subordonnées. Lorsque vous pensez que vous avez terminé votre page, relisez-la et révisez toute phrase qui a une structure trop compliquée.
Décidez comment vous adresser à vos lecteurs. Puisque DokuWiki est orienté vers la rédaction de documentation, vous devrez souvent indiquer à vos lecteurs comment faire certaines choses. Vous pouvez utiliser l' impératif formulaire ( « Faites ceci! »), Le nous / vous former ( « Ensuite nous / vous cliquez sur … ») ou je forme ( « je puis ajouter le foo à la barre, à l' aide … »). Ne mélangez pas ces formes.
Vérifiez votre page pour les erreurs grammaticales ou d'orthographe avant de l'enregistrer. Si votre texte contient de nombreuses erreurs, cela diminuera la crédibilité de vos déclarations, quelle que soit leur qualité.
Développez votre propre style. Ne vous forcez pas à écrire d'une manière avec laquelle vous n'êtes pas à l'aise. Cela ne semblerait que contre nature et serait désagréable à lire.

Lorsque vous rencontrez un terme qui nécessite plus d'explications, ajoutez une nouvelle page wiki pour le terme et un lien vers elle.
Vérifiez à nouveau votre page avant de la terminer et ajoutez des liens vers des pages wiki existantes aux termes centraux de votre page.
N'ajoutez pas de lien vers chaque occurrence d'un terme spécifique. Faites de la première occurrence / la plus importante sur la page un lien et ajoutez peut-être un lien vers la section de référence.
Fournissez des liens vers les sources d'images, de données et de citations.
Pensez à ajouter une ligne «Voir aussi:» à la fin de votre page. Fournissez des liens vers des pages wiki étroitement liées au sujet de votre page.
Si vous souhaitez donner des pointeurs vers des ressources externes contenant des informations supplémentaires sur votre sujet ou que vous avez utilisées pour rédiger votre page, ajoutez une section intitulée «Références» ou «Informations complémentaires» à la fin et donnez une liste de liens ou d'autres pointeurs ( ex. numéros ISBN). Si vous ne l'avez pas déjà fait dans le texte principal, indiquez l'intention de la référence.
La configuration de raccourcis interwiki peut aider à créer des liens vers des ressources communes.

“Une image vaut plus que mille mots.” Cela pourrait même signifier plus que ce que vous aviez l'intention de dire. Les humains ont tendance à remettre en question l'authenticité des images moins que celle du langage. Une courte description textuelle vaut mieux qu'une image inexacte.
Comme pour les tableaux, fournissez toujours une légende pour les images, qui indique ce que vous voulez montrer avec l'image.
Si vous n'avez pas créé l'image vous-même, indiquez la source (éventuellement avec un lien) et le droit d'auteur.
Ne liez pas des images de sites externes, sauf si vous y êtes autorisé explicitement. C'est d'abord une question de droit d'auteur, mais cela peut aussi être une question de vol de bande passante lorsque la mise en cache des images externes est désactivée.
Si l'image dépasse environ un tiers d'une page d'écran, utilisez un lien avec des instructions de redimensionnement pour insérer une vignette.