Table of Contents

Idées pour contribuer au wiki de docs.slackware.com

Contribuer à la documentation d'un projet peut être une tâche vraiment enrichissante et satisfaisante, mais beaucoup de contributeurs potentiels sont intimidés par la perspective d'écrire une documentation. L'idée derrière un wiki n'est pas de créer une documentation parfaite directement, mais d'encourager la communauté à faire des améliorations progressives pour finaliser le document. Inutile donc d'être déconcerté par cette idée.

Chacun peut choisir le ou les sujets auxquels contribuer, en se sentant à l'aise de rajouter des connaissances. Voici quelques sujets qui peuvent présenter un intérêt particulier pour des contributeurs potentiels.

Éditer, développer, améliorer

Éditer, développer et améliorer les articles existants est un bon exercice pour s'impliquer et contribuer à une documentation sous wiki. En tant que projet collaboratif toutes les corrections et améliorations sont bienvenues.

Il ne faut pas croire qu'éditer ou corriger est moins important qu'écrire un nouvel article ! Éditer, corriger et améliorer fait partie intégrante d'un wiki, et il est important de maintenir le contenu à jour.

Merci de lire le guide de style et l'étiquette du Wiki avant de commencer à éditer le travail de quelqu'un d'autre.

Rédaction d'article

Quand vous serez suffisamment à l'aise avec l'édition et l'amélioration d'articles existants, voilà quelques idées pour participer à l'élaboration de la documentation, sans ordre particulier.

HOWTOs/Tutoriels

Les HowTos, documents pour effectuer certaines tâches spécifiques ou parvenir à un certain résultat, sont très appréciés par la communauté du logiciel libre. Ces HowTos mettent l'accent sur une tâche spécifique et comment l'effectuer, pas à pas, avec des explications et des illustrations. Les notes et les avertissements jouent un rôle important dans ce type d'articles et aident le lecteur à éviter certains pièges.

Quelques exemples de potentiels HowTos :

et tout ce qui peut vous passer par la tête.

Programmes ou applications spécifiques

Cette catégorie recense des articles courts et informatifs relatifs à des programmes ou des applications spécifiques. Ces articles ne sont pas destinés à être des substituts pour les pages d'aide générées par la commande man. Toutefois, ils peuvent fournir l'information nécessaire pour commencer à utiliser les programmes ou applications en question et aussi s'attarder sur des caractéristiques particulières qui pourraient nécessiter de plus amples détails.

A titre d’exemple, les applications bureautiques ou les outils de gestion de paquets constituent des sujets potentiels.

Articles généraux

Il s'agit ici d'articles ne ciblant pas un problème technique en particulier mais plutôt se concentrant sur des sujets de plus large portée. L'inclusion de détails techniques dans un article général est facultatif. L'article peut toutefois être étendu plus tard afin de fournir des liens ou des pointeurs vers des sources d'information plus détaillées et techniques portant sur des sujets identiques ou similaires.

L'article A la Slackware est un exemple d'article général.

Les sujets à couvrir

La liste suivante est basée sur la suggestion de Woodsman. Elle peut faire office de guide pour l'ajout de contenus sur le wiki.

Sujets inappropriés

En dépit de la liberté d'expression et de création offert par un Wiki, certains sujets sont à éviter. Il s'agit de ce qu'il vaut mieux éviter dans un wiki. Certains d'entre eux peuvent être:

Afin d’éviter la duplication de contenu, les contributeurs potentiels devraient également vérifier l'existence d'un sujet dans le wiki avant de créer une nouvelle page avec un sujet similaire.

Sources