Carnet Wiki

Charte éditoriale de SPIP-Contrib

Version 2 — Novembre 2012 JLuc

Comment écrire un article sur spip-contrib ? et sur spip . net ?

Voici un recueil de recommandations basiques mais nécessaires .La plupart pourront vous sembler basiques, mais l’expérience montre que malheureusement elles ne sont pas toujours respectées.

A 1 . Savoir de quoi on parle

Savoir de quoi on parle, ça semble vraiment évident quand on commence à écrire un article. Mais savoir de quoi on parle, c’est aussi savoir de quoi on ne parle pas.
Chaque sujet abordé mais « hors sujet » est une distraction par rapport à l’objet de l’article, et induit donc une perte de pertinence et une perte d’efficacité à cette documentation.

En conséquence :

  1. Le titre de l’article doit annoncer le sujet principal de l’article et préciser son approche
  2. Savoir de quoi on parle dans un article donné implique de pas aborder parler de 1001 autres sujets trucs différents dans cet article, ni même 10 : juste parler de ce dont on a choisi de parler dans cet article.
    -# Il en va de même pour chaque partie : chaque intertitre doit annoncer le contenu de la partie suivante, qui ne doit aborder que ce sujet là.
    -# Enfin, chaque paragraphe et chaque phrase doivent s’intégrer dans une progression logique et ne pas digresser.-# Savoir de quoi on parle dans chaque partie de l’article (entre 2 intertitres) implique de pas parler de 100 autres trucs différents dans cette partie, ni même 5 : juste parler dans cette partie de ce qui est annoncé par le titre de cette partie.
    -# Savoir de quoi on parle dans chaque paragraphe pour pas parler de 10 autres trucs différents dans ce paragraphe, ni même 5, ni 3.
    -# savoir de quoi on parle dans chaque phrase pour pas parler de 3 autres trucs différents dans chaque phrase. Une idée, une phrase, c’est un bon modèle.

Les notes de bas de page et les remarques sont des manières d’introduire des précisions ou des digressions, mais elles doivent toujours uniquement servir l’objet principal de l’article.

Leur abus rend la lecture difficile et ne permet plus de distinguer l’essentiel de l’accessoire, donc il ne faut pas en abuser. Trop de notes tuent la note.

B. spip-contrib est un site documentaire autour de SPIP

Il y a donc une dimension informatique, pédagogique, explicative, documentaire.

Les informations diffusées doivent être exposées progressivement.

Chaque article s’adresse à un public donné. Il n’est en général pas possible de s’adresser à tous les publics : un certain prérequis est nécessaire. Selon les articles, ce prérequis peut être basique ou très évolué, dans différents domaines (connaissance du web, création basique ou avancée de squelettes, connaissance de MYSQL, de PHP, de javascript...). Une fois le choix de ce public fait, il faut s’y tenir.

L’auteur d’un article ne maîtrisant parfois qu’imparfaitement le sujet dont il parle, il est important de faire la part des choses entre 1) ce qui est certain 2) ce qui est incertain.
-  Un article dans spip-contrib doit être « suffisamment » complet et exact sur le sujet abordé.
-  Les informations dans un article doivent être certaines.

Les informations incertaines ou incomplètes peuvent éventuellement alimenter un article du Carnet, le temps d’être complétées, validées et mises en forme.

Le vocabulaire employé doit être adéquat au domaine considéré.

C. spip-contrib spip-contrib n’est pas un blog sentimental

Spip-contrib n’est pas un blog sentimental, et donc il ne faut pas y mélanger les avis personnels sur les membres de l’équipe spip, ou sur des discussions ayant eu lieu sur IRC.

Comment spip-contrib n’est pas un blog sentimental, il ne faut pas y mélanger les avis personnels sur les membres de l’équipe spip, ou sur des discussions ayant eu lieu sur IRC. Il ne faut pas non plus arroser le texte d’impressions personnelles, de ressentiment à l’égard de certains aspects de SPIP ou des SPIPeurs : juste expliquer, présenter, documenter.

Autrement dit En conséquence :

  1. ne pas mêler la vie des spipeurs ou d’IRC avec les documentations ou explications pédagogiques.
  2. ne pas mêler des sentiments personnels avec les documentations ou e’xplications explications pédagogiques

D. spip-contrib n’est pas un blog artistique

Les maniérismes littéraires nuisent en général à la fonction de spip-contrib qui est de transmettre le mieux possible un contenu pratique ou technique.