Gentoo Linux Wiki:Conventions de style

De Gentoo Linux Wiki.

Documents Officiels

Aide FAQ Conventions de style Guide d'édition de Mediawiki Conventions de nommage Guide de Wikification Site Web À propos Liste des administrateurs Liste de diffusion Articles souhaités Copyrights Divers IRC Backups

Les articles de Gentoo Wiki sont essentiellement des "howto" contenant les instructions à suivre pour installer, configurer et utiliser un logiciel ou du matériel.

Sommaire 1 Style d'écriture 2 Style de la page 3 Format 3.1 Articles sur le matériel 4 Discussion 5 Catégories

[modifier] Style d'écriture

Les articles doivent être rédigés dans un français correct, évitez les termes trop techniques autant que possible. Si des termes techniques sont utilisés (directement ou par un lien vers un site externe), ils doivent être expliqués..

Les articles doivent être écrits à la 3ème personne. N'utilisez pas de "je" ou "moi". A la place parlez à la personne lisant votre article en utilisant "vous".

[modifier] Style de la page

Le but des articles est d'être utile, pas beau. Les images ne doivent pas être utilisées pour décorer les articles.

[modifier] Format

Les articles doivent contenir ce qui suit dans le même ordre :

• Commencez avec un résumé du sujet de l'article.
• Détaillez le but de l'article et les pré-requis (logiciels ou connaissances). Vous pouvez aussi mentionner les sujets liés à l'article que vous n'allez pas couvrir et où trouver l'information sur ces sujets.
• Guidez l'utilisateur étape par étape, en expliquant ce que les commandes font, particulièrement quand elles sont complexes.
• Fournissez une section "Problèmes courants" si nécessaire. Cette section devrait contenir les problèmes ou erreurs couents, et comment les résoudre.
• Listez tous les articles liés, même s'ils sont déjà cités dans l'article lui-même. Cette liste peut inclure des articles de sites externes.
• Assurez vous d'utiliser les modèles qu'il faut.

[modifier] Articles sur le matériel

Les articles concernant le matériel doivent avoir les informations supplémentaires suivante :

• Quand c'est approprié, la sortie de "lspci -nn" ou "lsusb".
• Les autres noms connus pour le même matériel.

[modifier] Discussion

Les discussion doivent avoir lieu dans la page de discussion de l'article, pas dans l'article lui même.

[modifier] Catégories

Les catégories ([[Catégorie:Foo]]) doivent être à la find es articles. Tous les articles doivent être dans au moins une catégorie.