Les bonnes pratiques pour Confluence: Le Dodécalogue


Publié par
Cyrille MARTIN

19 avril 2010

Face à une page d’un Wiki comme Confluence, Mediawiki, Tikiwiki, Xwiki, … (la liste est longue, je m’arrête là) il n’est pas évident de savoir ce qu’il faut faire et ne pas faire.
Pour vous aider en tant que contributeurs ou animateurs voici les 12 règles à respecter et à appliquer.

1. Faire des références à d’autres pages

Cela permet au lecteur de naviguer au travers de toute l’information présente sur le Wiki.

2. Utiliser les labels

L’ajout de labels à une page ou une nouvelle facilite sa recherche et classifie l’information présente dans la page.

3. Utiliser les templates de page

Les templates apportent une structure au contenu de la page et permet une meilleure lisibilité.

4. Corriger les coquilles

Lors de la lecture si vous voyez des fautes dans une page, prenez le temps de la corriger.

5. Ajouter / Compléter du contenu

Compléter les pages quand vous avez des informations supplémentaires même si vous n’êtes pas sûrs à 100%, d’autres viendront corriger si c’est faux.

6. S’abonner aux pages

Abonnez-vous aux contenus qui vous intéressent pour rester informer de ses mises à jour.

7. Ne pas faire de pages vides

Mettez toujours un minimum de contenu dans une page que vous avez créée afin que les personnes arrivant sur votre page ne soient pas déçues.

8. Ne pas limiter l’accès

Essayez de laisser un maximum de contenu accessible à tous.

9. Ne pas faire de page trop longue

N’hésitez pas à découper le contenu d’une page en plusieurs pages filles afin d’améliorer la lisibilité.

10. Ne pas renommer les pièces jointes

Si vous avez modifié le contenu d’une pièce jointe, attachez la à la page avec son nom d’origine, Confluence gère aussi en version les pièces jointes.

11. Ne pas passer de temps sur la customisation graphique

Les choses les plus importantes dans un wiki sont son contenu et l’organisation de celui-ci.

12. Ne pas être timide ou réservé

Donnez votre avis sur le contenu que vous lisez en faisant des commentaires.

Tips via Twitter for Confluence enterprise wiki

  • Merci Gauthier :)

  • Gauthier R

    Bon article !

    Bon ben… j’applique le point 4 :

    pour le point 1 : au travers toute l’information -> au travers *de* toute l’information
    pour le point 5 : quand avez des informations -> quand *vous* avez des informations
    pour le point 10 : attachez là à -> attachez *la* à

    Cdt.

  • BAPTISTE

    Bonjour à tous,

    Je débute dans confluence et j’aurai aimé un peu d’aide.Pouvez vous rappelez les règles de classification des documents (les tags) dans un wiki. J’ai du mal à comprendre ce qu’est un user macros où le template de page, pouvez vous l’expliciter.
    merci d’avance:)

  • Pascal Carnec

    Première visite, 1er commentaire : ne faut-il pas appliquer à ce blog le principe : 9. Ne pas faire de page trop longue ? 😉

  • Malgré la contrainte des user macros, celles-ci s’avèrent très utiles en les considérant comme des « fonctions » à part entière. Avec accès à pas mal de ressources Confluence en terme d’API (justement, des fois trop), on peut pour ainsi dire tout faire sans passer par la case « plugin ». Coupler ces user-macros avec les templates tend à donner encore plus de pouvoir aux templates.
    Etant dans un environnement certes avec peu de personnes (+/- 50), nous avons cependant souvent des demandes de création de user macros très intéressantes pour valoriser les contenus de pages. Et ces demandes dérivent souvent sur « on peut me filer les droits pour créer ces macros ? ». Confluence manque un petit peu de granularité en terme de permissions, surtout pour ces macros, qui en somme, agissent tel des plugins qu’on installerait et qu’on retrouverait dans le notation guide. Des user macros par espace seraient bienvenues.. on peut rêver !
    Bref je m’éloigne un peu. Tu as raison, ces 12 règles semblent être les « primordiales » avant toute chose.
    Bon article en tout cas :)

  • Corrigé ! (merci)

    Les macros permettent de faire beaucoup de chose dans Confluence mais il ne faut pas noyer les utilisateurs sous un monticule de macros qu’ils utilisent pas ou très peu.

    N’oublions pas que le but premier du Wiki est la collaboration.

    Je suis totalement d’accord avec toi; on peut élargir ces règles de bonnes pratiques, mais les 12 premières règles à satisfaire avant toute chose sont celles mentionnées dans l’article.
    L’utilisation des Team Label est indispensable sur une instance contenant beaucoup d’espace accessible à tous,

    L’utilisation de user macro est très contraignante car seul l’administrateur global de Confluence peut les créer.
    L’esprit de Confluence est de justement déléguer au maximum la gestion de contenu aux administrateurs d’espace ou aux jardiniers (encore une autre règle à adopter pour chaque espace) donc soit le contenu mutualisable peut être placé dans le template de page, soit faire une demande à l’administrateur global de créer une nouvelle user macro avec contenu souhaité et la mise en forme (cette solution manque de souplesse quand on est sur des instances très large.)

  • Intéressant.
    Quelques idées de plus :
    Les team leaders peuvent être amenés à créer des user-macros pour faciliter certains usages et éviter la redondance d’infos. Il est nécessaire de documenter ces user-macros dans un guide accessible à tous facilement pour réutilisation.
    De même, les user macros permettent de ne pas afficher certain code lorsqu’on veut visualiser le contenu en wiki-markup et qu’on n’a pas accès à l’édition de la page.
    Utiliser des team-labels pour les espaces afin d’assurer une classification cohérente.
    Utiliser les macros {excerpt} {excerpt-include} pour ne faire remonter que le contenu intéressant d’une page vers une autre tel un résumé.

    Et bien d’autres :)
    (btw 3ème ligne « Pour vous aidez » contient une faute :))