[SPIP Zone] doc pour spip-contrib

On voit passer en ce moment beaucoup d'articles sur spip-contrib du
type Notes de Machin qui renvoient à l'espace privé
(http://www.spip-contrib.net/Phpmailer-Notes) ou au wiki
(http://www.spip-contrib.net/Echoppe-Notes-de-developpement).
J'ai un peu le sentiment que ça fait "donnez-moi vos éléments et c'est
moi qui fais la synthèse", je trouve que ça n'incite pas tellement à
participer. Pourquoi ne pas utiliser le wiki de spip-contrib pour
monter collaborativement la documentation ?

Pour rappel le wiki, sous Gribouille, est ici :
http://www.spip-contrib.net/Carnet-SPIP

J'ai le sentiment que ce qui manque c'est la fonctionnalité de forum
pour une page du wiki, ce qui (comme on l'a sur wikipedia ou autre)
permet de discuter du contenu ou de faire des propositions sans rendre
l'article complètement imbuvable (avec des annotations, rajouts,
suppressions, commentaires, etc..)

Qu'en dites-vous ?

.Gilles

J'ai le sentiment que ce qui manque c'est la fonctionnalité de forum
pour une page du wiki, ce qui (comme on l'a sur wikipedia ou autre)
Qu'en dites-vous ?

C'est dans la todo de gribouille je crois ; et a priori il doit
suffire d'ajouter <INCLURE{fond=inc-forum}{id_article}> :slight_smile:

Sur gribouille personne n'a rien ajouté, mais c'est pourtant un
suelette comme les autres, hein, faut pas avoir peur

-- Fil

On Nov 6, 2007 5:22 PM, Fil <fil@rezo.net> wrote:

J’ai le sentiment que ce qui manque c’est la fonctionnalité de forum
pour une page du wiki, ce qui (comme on l’a sur wikipedia ou autre)

Qu’en dites-vous ?

C’est dans la todo de gribouille je crois ; et a priori il doit
suffire d’ajouter <INCLURE{fond=inc-forum}{id_article}> :slight_smile:

Sur gribouille personne n’a rien ajouté, mais c’est pourtant un
suelette comme les autres, hein, faut pas avoir peur

OK je m’y mets ce WE.
J’ai aussi sous la main des modifs pour le squelette de doc.spip.org, mais il me faudrait du contenu : quelqu’un peux-t-il m’envoyer un export de doc.spip.org ? Ce serait bien d’avoir ce dump (ou une partie) fourni avec le plugin, comme contenu type lors de l’install (je verrais bien ça dans un sous-répertoire install/…).

thnx,

.Gilles

– Fil

Gilles Vincent a écrit :

On Nov 6, 2007 5:22 PM, Fil <fil@rezo.net> wrote:

J'ai le sentiment que ce qui manque c'est la fonctionnalité de forum
pour une page du wiki, ce qui (comme on l'a sur wikipedia ou autre)
Qu'en dites-vous ?

C'est dans la todo de gribouille je crois ; et a priori il doit
suffire d'ajouter <INCLURE{fond=inc-forum}{id_article}> :slight_smile:

Sur gribouille personne n'a rien ajouté, mais c'est pourtant un
suelette comme les autres, hein, faut pas avoir peur

OK je m'y mets ce WE.
J'ai aussi sous la main des modifs pour le squelette de doc.spip.org, mais
il me faudrait du contenu : quelqu'un peux-t-il m'envoyer un export de
doc.spip.org ? Ce serait bien d'avoir ce dump (ou une partie) fourni avec le
plugin, comme contenu type lors de l'install (je verrais bien ça dans un
sous-répertoire install/..).

Euh, en fait, il y a un script qui alimente la base à partir du code, c'est ça le contenu, non ?

Pour la partie documentation générale, faut que ça marche non seulement pour ce qui est écrit, mais aussi pour ce qui pourra y être écrit plus tard, donc, je suppose que quand tu parles de contenu, c'est plutôt les fonctions, les fichiers etc, n'est-ce pas ?
--
James

James a écrit :

Gilles Vincent a écrit :

Ce serait bien d'avoir ce dump (ou une partie) fourni avec le
plugin, comme contenu type lors de l'install (je verrais bien ça dans un
sous-répertoire install/..).

je suppose que quand tu parles de contenu, c'est plutôt les fonctions, les fichiers etc, n'est-ce pas ?

Je crois que Gilles veux simplement un export (dump) de doc.spip.org pour modifier les squelettes et tester le résultat sur son pc avec un contenu type.

Après, sur les pages, il y a effectivement un contenu récupéré automatiquement (le chapo?) et le contenu ajouté par les developpeurs de passage... quand ils y pensent et avec crayons ce serait mieux ;)...

MM.

Matthieu Marcillaud a écrit :

James a écrit :

Gilles Vincent a écrit :

Ce serait bien d'avoir ce dump (ou une partie) fourni avec le
plugin, comme contenu type lors de l'install (je verrais bien ça dans un
sous-répertoire install/..).

je suppose que quand tu parles de contenu, c'est plutôt les fonctions, les fichiers etc, n'est-ce pas ?

Je crois que Gilles veux simplement un export (dump) de doc.spip.org pour modifier les squelettes et tester le résultat sur son pc avec un contenu type.

Je crois que j'ai bien compris :slight_smile:

Je propose une alternative qui peut s'avérer plus rapide, pereine et qui, de plus, permettrait, peut-être, de multiplier le nombre de personne capable d'apréhender un script maintenu par une seule personne, fortement occupée ailleurs ces temps-ci :slight_smile:

--
James

On Nov 6, 2007 7:12 PM, James <james@rezo.net> wrote:

Gilles Vincent a écrit :
> J'ai aussi sous la main des modifs pour le squelette de doc.spip.org, mais
> il me faudrait du contenu : quelqu'un peux-t-il m'envoyer un export de
> doc.spip.org ?

Euh, en fait, il y a un script qui alimente la base à partir du code,
c'est ça le contenu, non ?

Ah oui c'est vrai que pour ce site il y a les scripts qui
l'alimentent. Comme tu le dis, c'est la partie fonctions / fichiers
qui m'intéresse, le reste du contenu étant plus facile à intégrer. Il
me suffit aussi d'un petit jeu de test pour peaufiner le squelette (ça
ne va pas être de grosses modifs non plus hein :wink:

De mémoire le script est dans la zone sur _outils_/docspip, donc il ne
me reste plus qu'à l'utiliser :slight_smile:

.Gilles
----

Pour la partie documentation générale, faut que ça marche non seulement
pour ce qui est écrit, mais aussi pour ce qui pourra y être écrit plus
tard, donc, je suppose que quand tu parles de contenu, c'est plutôt les
fonctions, les fichiers etc, n'est-ce pas ?
--
James

Le 6 nov. 07, à 15:23, Gilles Vincent a écrit :
On voit passer en ce moment beaucoup d'articles sur spip-contrib du
type Notes de Machin

Oui c'est une politique volontariste de référencement des contribs, qui découle de l'expérience (ce n'est pas un raisonnement théorique). Même sous une forme basique un article et sa rubrique-dossier référencent déjà la contribution sur SPIP-Contrib (inclusion dans l'arborescence, les listes, les recherches, les fluxs, etc ..), donnent quelques éléments sur sa nature au lecteur, offrent un forum, etc ... et ce qui un point important cela crée régulièrement une dynamique pour commencer la documentation (pas à tous les coups mais régulièrement).

Un texte basculé du wiki au format "articles standard" dans une rubrique-dossier dédié, avec tout le travail de finition qui va avec (logo, mot clefs, syndication, présentation) voit souvent son audience multiplier par 30 ou plus, son forum vivre ... Parfois l'effet est spectaculaire : tel début de documentation qui végétait sur le carnet, voit son (ses) auteurs beaucoup plus motivé(s) et évolue rapidement, souvent du fait des retours lecteurs via le forum. L'investissement d'un (ou des) auteur(s) dans un articles est la condition de sa réussite.

J'ai un peu le sentiment que ça fait "donnez-moi vos éléments et c'est
moi qui fais la synthèse", je trouve que ça n'incite pas tellement à
participer.

L'expérience montre le contraire, voir ci-dessus

Pourquoi ne pas utiliser le wiki de spip-contrib pour
monter collaborativement la documentation ?

Parce que d'expérience cela ne marche pas, ou pas très bien, ou très rarement. Même quand des textes sont aboutis de cette manière ils posent le problème de leur aboutissement et de leur fiabilité dans le temps ... un bon exemple est la : "http://www.spip-contrib.net/Carnet-Mutualisation&quot;, il y a un super boulot, mais on ne sait plus ce qui est à jour, qui à dit quoi etc ... certains on essayé récemment de faire cette maj, mais ce n'est pas encore très clair. Je pense que, après avoir été amorcée sous carnet, cette doc aurait gagnée/gagnerais à être nettoyée et basculée en article classique beaucoup plus tôt (c'est un exemple, mais courant), et qu'elle serait plus utile ainsi.

Pour rappel le wiki, sous Gribouille, est ici :
Carnet Wiki

C'est dans le bandeau donc accessible. Si ce n'est pas plus utilisé c'est que souvent il est plus efficace, ou plus motivant pour le/les auteurs, de faire directement un article classique quitte à le faire évoluer ensuite après publication (cas fréquent et encouragé)

J'ai le sentiment que ce qui manque c'est la fonctionnalité de forum
pour une page du wiki, ce qui (comme on l'a sur wikipedia ou autre)
permet de discuter du contenu ou de faire des propositions sans rendre
l'article complètement imbuvable (avec des annotations, rajouts,
suppressions, commentaires, etc..)

je ne vois pas en quoi des mises à jour bien menées rendent un article imbuvable par nature ... au contraire c'est souvent comme cela que les plus intéressants sont construits : par passes successives. Mais peut être fait tu référence à un article wiki .. oui dans ce cas il y a toujours le problême des synthèses ou débats. Ce qui me parait pas clair dans l'idée "page wiki + forum" c'est ou mettre quoi , à quel moment modifier la page plutot que poser un message de forum ?. Qu'est ce que cela apporte alors par rapport au systeme classique : articles (éventuellement muliti auteurs) + forums ?

Mon avis est que "carnet wiki" et "article classique" ne sont pas à opposer mais correspondent à des moments différents, ou des contextes d'usage différents ... et souvent pour l'usage des docs de contribs il est plus efficace de commencer directement, ou très tôt, un article.

voila, voila pourquoi il y a en "ce moment beaucoup d'articles sur spip-contrib de type Notes de Machin"

@+ NicolasR

Le 7 nov. 07, à 01:25, nicolasriq@free.fr a écrit :
... un bon exemple est la :
"http://www.spip-contrib.net/Carnet-Mutualisation&quot;, il y a un super
boulot, mais on ne sait plus ce qui est à jour, qui à dit quoi etc ...
certains on essayé récemment de faire cette maj, mais ce n'est pas
encore très clair. Je pense que, après avoir été amorcée sous carnet,
cette doc aurait gagnée/gagnerais à être nettoyée et basculée en
article classique beaucoup plus tôt (c'est un exemple, mais courant),
et qu'elle serait plus utile ainsi.

hum , erreur de ma part c'est à "http://www.spip-contrib.net/MultiBase&quot; auqel je pensais. Maintenant l'article sur la mutualisation gagnerais certainement à être dorénavant fiabilisé, pérenisé en le basculant en "article classique". le probleme est que cela va être un vrai travail pour ce faire, et qu'il n'est pas sur que quelqu'un en ai le courage, ce qui serait dommage.

@+ NicolasR

Bonjour

Enfin je rebondi sans avoir trop réfléchi donc c'est un peu brut de pomme.

Je pense par exemple à www.spip-contrib.net/plugin-xml qui est une
page wiki et qui à mon sens doit le rester.
Ce n'est pas la propriété d'un auteur, c'est facilement mis à jour,
suffit de voir l'historique.
Mais en contre partie, cette page n'a aucune visibilité car elle n'est
pas (entre autre) référencée dans la page
http://www.spip-contrib.net/Tutoriaux-pour-Plugins

Je pense aussi aux articles wiki "Comment ça marche" (les ccmXX) qui
pourraient avoir plus de vie si ils étaient référencés aussi dans
la/les rubriques de contrib.
Par exemple les ccm sur le compilateur.

Ce qui pourrait être bien c'est de pouvoir facilement tagguer ces
articles (comme avec le mot clef documentation) et/ou de pouvoir les
appeler (redirection ?) depuis la rubrique mère.

Désolé pour le bru(i)t.

Km

On 11/7/07, Joseph <joseph@larmarange.net> wrote:

à propos de doc.spip.org,

il serait bien de pouvoir compléter la doc en plus de la doc
automatique. Or, nous savons bien que les dev n'ont guère le temps de
s'en occuper. Mais peut-être les forums associés à un article pourraient
être activés, ou bien un champs de l'article (par exemple le PS) rendu

Le problème que j'ai eu avec la doc c'est que je ne sais pas si mes
commentaires privés dans l'interface privée sont pris en compte ou pas
(+ généralement je n'ai pas de RSS sur les commentaires privés du
site) : c'est vite limité, car finalement dans docspip les
commentaires privés ont la meme valeur que les articles pour un site
éditorial classique.. (je rève d'un lien 'vos commentaires privés'
dans l'interface d'admin :slight_smile:

j'ai par exemple mis des commentaires sur les articles 3787 et 3826 :
pour le dernier j'ai hésité à créer une page dans le wiki de
spip-contrib, vu comment j'en ai bavé pour le formatage (autre
problème des commentaires : il est difficile de proposer un morceau de
doc directement avec le formatage -- indispensable pour qu'il soit
repris correctement si l'on prend en compte que ceux qui intègrent /
valident tout ça ont "plein" de trucs à intégrer)

Je suis d'accord avec Joseph, pour moi docspip devrait être un wiki
pour la vrai doc (donc utiliser massivement crayon), ça simplifierait
drolement les choses..
Par contre je ne pense pas que cela entrainerait une perte de qualité
de la doc : au contraire, si on multiplie les correcteurs potentiels,
il est plus simple de la maintenir à jour

La documentation officielle de Trac est par exemple construise comme
cela : certes on peut avoir des actes de vandalisme mais ils sont vite
corrigés car on peut facilement revenir à une version antérieure (gros
problème de crayon)

.Gilles
---

modifiable par tous via crayon. Le but du jeu c'est de permettre à ceux
qui consultent doc.spip;org de pouvoir proposer des compléments de docs.
Bien sur, il s'agirait d'une doc sous réserve mais cela fournirait des
éléments additionnels qui pourraient aider à une doc plus officiel par
la suite.

PS : cf. un post précédent sur ce sujet.

joseph

Gilles Vincent a écrit :

La documentation officielle de Trac est par exemple construise comme
cela : certes on peut avoir des actes de vandalisme mais ils sont vite
corrigés car on peut facilement revenir à une version antérieure (gros
problème de crayon)

.Gilles
---

Normalement on peut revenir en arrière garce à l'historique des versions. Non ?

Jo