Vous êtes ici: La documentation de Slackware-fr » Venez contribuer !

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 vie, aider et mettre une bonne ambiance sur le forum.
  • Utiliser, corriger, mettre à jour ou proposer des Slackbuilds.
  • Relire, corriger ou écrire de la documentation. Voir ci-dessous.

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.

  • Pour éviter les dégradations en tout genre, vous devez être inscrit et identifié pour obtenir des droits d'écriture.
  • Vous pouvez modifier tous les documents, à l'exception de certaines pages réservées aux administrateurs. Mais il y a une bienséance à respecter si vous n'êtes pas l'auteur :
    • Une règle tacite veut qu'un auteur ait toujours le dernier mot concernant sa production. Afin de proposer vos modifications, si possible après avoir demandé, vous pouvez créer un brouillon de votre version modifiée.
    • Vous pouvez corriger les petites erreurs : fautes d'orthographes, de grammaires, de mise en page, lien cassé, etc… Ce que nous appelons aussi coquilles.
    • Pour modifier plus profondément le document, il vous faut demander à l'auteur. Pour cela poser la question sur la liste de diffusion SlackLab.
  • Vous pouvez créer une nouvelle page dans les brouillons. Afin de profiter des conseils de la communauté et d'éviter tout travail n'entrant pas dans la vue d'ensemble, nous vous recommandons de vous inscrire à la liste de diffusion SlackLab.
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 :

  • Avant tout désir de création, cherchez s'il n'existe pas déjà des documents sur le même sujet. Si c'est le cas, discuter de l'orientation de votre document et de ce qui est le plus opportun à faire.
  • Relisez-vous, vérifier les liens internes et externes, demandez à ce que l'on vous relise.

Contenus obligatoires

Ce que nous voulons voir dans tout document :

  • Tout document commence par un titre de niveau 1 (H1 soit le code ====== le titre ======).
  • Chaque document à un auteur. Pour l'indiquer, nous vous proposons de coller ceci : Par **<votre nom/pseudo>**.. Ou si vous avez votre page contributeur, Par **[[wiki:contributeurs:<votre page>]]**. suffit. Sachant que DokuWiki utilisera le titre de votre page pour le nom du lien.
  • Ajoutez les tags à la fin du document. Pour le moment, contentez-vous des tags existants. La syntaxe combine deux plugins et donne ceci : ++++ Tags | {{tag>... }} ++++, en remplaçant par la liste des tags, séparés par un espace, si possible dans l'ordre alphabétique.


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 :

  • mail : courriel ;
  • package : paquet ;
  • spam : pourriel ;
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 :

  • Cherchez autant que possible et lorsque c'est judicieux de pointer d'autres documents existants, afin d'établir des ponts. Éviter les liens ici et  ! Construisez vos phrases afin d'ajouter le lien sur les mots significatifs.
  • Mettre en forme les documents avec les syntaxes offertes afin d'apporter le plus de la lisibilité possible. La lecture des syntaxes offertes est vivement conseillée.
  • Pour les informations techniques, utilisez les syntaxes disponibles pour les distinguer. Pour un bloc technique de plusieurs lignes <code>…</code>. Et pour une information technique dans du texte ''...''. Vous avez aussi la possibilité de distinguer le contenu d'un fichier avec <file>…</file>.
  • Nous sommes sur un site dédié à la Slackware, il est donc inutile de préciser plus d'une fois que le document concerne la Slackware. ;-)

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 :

  • CQ : coquilles, quand vous n'avez fait que corriger un lien, une faute, etc.
  • MEF : mise en forme, quand vous remettez le contenu en forme, le rendre plus lisible, propre… (et non MEF pour Méfiance ! ;-) )
  • RI : rédaction initiale, quand vous êtes en train de rédiger la première mouture de votre page, inutile de dire à chaque fois ce que vous faites.


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

site/slack.txt · Dernière modification: 2010/08/26 19:59 (édition externe)