Table des matières

Venez contribuer !

Nous allons essayer de vous donner les clés pour contribuer efficacement, afin que tout le monde, vous, les visiteurs et nous ayons le plus de plaisir et le moins de déconvenues possibles.

Il va sans dire que tout le monde est le bienvenue et peut prendre part à la vie du site et participer ! Aucun pré-requis technique n'est demandé, sachez juste vous exprimer en un Français relativement correct. Oubliez le langage SMS ! :-P

Ce vous pouvez faire

Le site appelle à vivre et évoluer. Dans cette optique, nous vous invitons vivement à proposer vos idées d'évolutions ou de nouveaux outils. À ce jour, voici ce que vous pouvez faire :

Participer à la documentation

La documentation est hébergée, évolue et est mise en ligne via un wiki. Nous avons limité les droits de modifications seulement aux personnes qui sont enregistrées sur le site. Et bien que une fois enregistré vous pouvez tout modifier, nous avons établi quelques règles.

Les règles

Les règles pour participer à la maintenance, la correction ou la création de documentations sont relativement simples. Merci d'avance à faire attention et à les respecter.

Nous ne voulons pas jouer à la police et vous ne voulez pas faire quelque chose pour vous rendre compte après coup que nous ne le mettrons pas en ligne pour diverses raisons. Pour éviter à tout le monde de faire quelque chose que nous n'aimons pas faire, inscrivez-vous et demandez conseils et avis sur liste de diffusion SlackLab.

Nous nous répétons, mais disons les choses autrement. ;-)

Nous commençons par le plus simple, si vous voyez une faute de grammaire ou d'orthographe, ou une mauvaise mise en forme, ou une petite erreur technique, vous pouvez la corriger directement. Si par contre, vous souhaitez mettre à jour un document dans son ensemble, demandez l'avis de l'auteur et des autres contributeurs sur la liste de diffusion SlackLab. Afin de proposer vos modifications, vous pouvez créer un brouillon de votre version modifiée. Enfin, si vous voulez écrire un nouveau document, avant toute chose demandez l'avis des autres contributeurs sur la liste de diffusion SlackLab. Une création doit obligatoirement passée par l'étape brouillons afin de bénéficier des retours et avis des autres contributeurs.

Quoique vous fassiez, nous vous demandons de toujours en informer la communauté avec un courriel sur SlackLab.

Un petit mot disant « Salut, Juste un petit coucou pour signaler la correction de coquilles sur <url de la page>. » ne peut pas faire de mal.

Aide à la rédaction

Afin de garder une documentation cohérente, non redondante et de qualité, nous vous indiquons un certains nombres de points que vous pouvez d'ores et déjà prendre en compte.

Une vue générale

La première chose consiste à prendre du recul par rapport à l'idée de document que vous avez :

Contenus obligatoires

Ce que nous voulons voir dans tout document :


La Slackware et le monde Linux en général étant très anglophone, certaines traductions ont donc été choisies plutôt que d'autres :

Cependant il ne s'agit pas de franciser à tout prix, les anglicismes sont tolérés quand ils sont largement utilisés de même que la francisation doit avoir un peu d'ancrage dans la réalité (pas la peine de vous la jouer recommandations sénatoriales, le but est quand même de rester compréhensible par le reste du monde).

Mise en forme et contenu

Voici quelques points précis pour la mise en forme et le contenu, et la relation entre les deux, d'un document :

Typographie rapide des changements

Le champs Résumé: peut parfois être pénible à remplir, c'est pourquoi vous pouvez vous contenter dans certains cas de mettre des abréviations :


Cela étant dit, un bon commentaire concis et précis, aide toujours à la clarté générale.

Comme toujours et pour tout, si vous avez d'autres idées, n'hésitez pas à les soumettre sur la Slacklab.

En guise de conclusion, nous laissons le mot de la fin à Patrick : As always -- Have fun ! ;-)

Tags