Version 3 — Novembre 2012 — Maïeul
Comment écrire un article sur spip-contrib ?
Voici un recueil de recommandations basiques mais nécessaires.
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.
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 :
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, ces abus sont donc à proscrire il ne faut pas en abuser . Trop de notes tuent la note.
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.
- 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é.
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.
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 :
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.