[SPIP Zone] [Spip-zone-commit] r11857 - in /_plugins_/_test_/sedna: README plugin.xml

Le 4 mai 07, à 10:43, fil@rezo.net a écrit :
Author: fil@rezo.net
Date: Fri May 4 10:43:10 2007
New Revision: 11857
Log:
avec de la doc
- Documentation à venir sur [->www.spip-contrib.net/Sedna-agregateur]

Je propose de transformer cette page wiki en "vrai" article, dans l'esprit de ce qui c'est fait pour "autorité". à mon avis ce texte est adapté pour ce faire, et la doc est plus efficace et visible pour tout le monde comme cela. Si c'est ok je m'occupe de la manip

@+ NicolasR

Le 5 mai 07, à 16:58, nicolasriq@free.fr a écrit :

Le 4 mai 07, à 10:43, fil@rezo.net a écrit :
Author: fil@rezo.net
Date: Fri May 4 10:43:10 2007
New Revision: 11857
Log:
avec de la doc
- Documentation à venir sur
[->www.spip-contrib.net/Sedna-agregateur]

Je propose de transformer cette page wiki en "vrai" article, dans
l'esprit de ce qui c'est fait pour "autorité". à mon avis ce texte est
adapté pour ce faire, et la doc est plus efficace et visible pour tout
le monde comme cela. Si c'est ok je m'occupe de la manip
@+ NicolasR

je rebondis volontairement sur ce fil de discussion pour donner mon avis sur la méthode de documentation sur SPIP-Contrib des développements de la Zone.

Je vois que pour la page Carnet ci-dessus les stats indiquent : "8 visites popularité 5" pour une journée en ligne. C'est au minimum 50 fois moins que ce qui serait obtenu par un article classique passant par la page sommaire de Contrib. En clair une telle page est peu visible, ce qui est dommage. Le Carnet wiki à mon avis se justifie surtout comme support de travail pour une équipe existante (genre définir un concept, un article, à plusieurs), mais pas pour trouver du public.

Les autres avantages pour cet usage d'un format "article classique", par rapport au format "article Carnet wiki" sont ;
- forum associés permettant les retours lecteurs
- intégration aux flux rss
- intégration a tout le systeme de navigation du site (mots clefs, rubriquage par fonctions), rendant votre travail visible par la majorité
- indexation par les divers moteurs de recherche
- avec Crayons un article classique est aussi pratique à modifier pour les admins qu'une page wiki

Vous me direz : "je développe déjà , je n'ai pas le temps de rédiger une doc en plus" ... certes, et bien raison de plus pour ne pas se créer une surcharge de travail avec une étape intermédiaire : allez droit au but en amorçant un article même succint (par exemple a partir du texte de votre plugin.xml). Votre doc évoluera ensuite une fois en ligne avec le code.

Il ne faut plus penser la doc comme une corvée "en plus", que l'on fait "apres" avoir abouti le code. mais au contraire comme une partie de celui-ci, à construire en même temps que le reste. Les retours lecteurs via les forums, votre propre effort de rédaction sur votre travail, seront utiles à votre code en création.

Dans cette logique SPIP-Contrib doit être pensé comme une "Zone de la doc" (et non pas la doc de la seule Zone)

A vos plumes et vos crayons donc

@+ NicolasR

Le 5 mai 07 à 18:41, nicolasriq@free.fr a écrit :

Le 5 mai 07, à 16:58, nicolasriq@free.fr a écrit :

Le 4 mai 07, à 10:43, fil@rezo.net a écrit :
Author: fil@rezo.net
Date: Fri May 4 10:43:10 2007
New Revision: 11857
Log:
avec de la doc
- Documentation à venir sur
[->www.spip-contrib.net/Sedna-agregateur]

Je propose de transformer cette page wiki en "vrai" article, dans
l'esprit de ce qui c'est fait pour "autorité". à mon avis ce texte est
adapté pour ce faire, et la doc est plus efficace et visible pour tout
le monde comme cela. Si c'est ok je m'occupe de la manip
@+ NicolasR

je rebondis volontairement sur ce fil de discussion pour donner mon
avis sur la méthode de documentation sur SPIP-Contrib des
développements de la Zone.

Je vois que pour la page Carnet ci-dessus les stats indiquent : "8
visites popularité 5" pour une journée en ligne. C'est au minimum 50
fois moins que ce qui serait obtenu par un article classique passant
par la page sommaire de Contrib. En clair une telle page est peu
visible, ce qui est dommage. Le Carnet wiki à mon avis se justifie
surtout comme support de travail pour une équipe existante (genre
définir un concept, un article, à plusieurs), mais pas pour trouver du
public.

déjà, il n'y a pas de bloc carnet sur la page sommaire (contrairement aux sites de la galaxie). Ce n'est pas beaucoup mais ce peut être un plus. Ou alors, comme "Derniers commentaires" une "nouvelles pages Carnet".

Les autres avantages pour cet usage d'un format "article classique",
par rapport au format "article Carnet wiki" sont ;
- forum associés permettant les retours lecteurs
- intégration aux flux rss
- intégration a tout le systeme de navigation du site (mots clefs,
rubriquage par fonctions), rendant votre travail visible par la
majorité
- indexation par les divers moteurs de recherche
- avec Crayons un article classique est aussi pratique à modifier pour
les admins qu'une page wiki

Vous me direz : "je développe déjà , je n'ai pas le temps de rédiger
une doc en plus" ... certes, et bien raison de plus pour ne pas se
créer une surcharge de travail avec une étape intermédiaire : allez
droit au but en amorçant un article même succint (par exemple a partir
du texte de votre plugin.xml). Votre doc évoluera ensuite une fois en
ligne avec le code.

Il ne faut plus penser la doc comme une corvée "en plus", que l'on fait
"apres" avoir abouti le code. mais au contraire comme une partie de
celui-ci, à construire en même temps que le reste. Les retours lecteurs
via les forums, votre propre effort de rédaction sur votre travail,
seront utiles à votre code en création.

Dans cette logique SPIP-Contrib doit être pensé comme une "Zone de la
doc" (et non pas la doc de la seule Zone)

A vos plumes et vos crayons donc

@+ NicolasR

Claude

Le 5 mai 07, à 20:22, dlatr a écrit :
déjà, il n'y a pas de bloc carnet sur la page sommaire (contrairement aux sites de la galaxie). Ce n'est pas beaucoup mais ce peut être un plus. Ou alors, comme "Derniers commentaires" une "nouvelles pages Carnet".

comme il est dit dans la doc, le sceteur wiki est exclu de toutes les boucles. Il n'est donc pas possible de construire de "bloc carnet" sur la page sommaire. J'ai proposé sur l'article de cette contrib d'inclure un critère dérogatoire pour pouvoir contourner ce probleme, mais il faut laisser du temps au temps.

Quoiqu'il en soit cela ne change pas mon propos qui est que dans la plupart des cas le passage par la case "page Carnet wiki" pour la doc des plugins est à éviter car gaspillage d'efforts.

@+ NicolasR

Le 5 mai 07 à 22:54, nicolasriq@free.fr a écrit :

Le 5 mai 07, à 20:22, dlatr a écrit :
déjà, il n'y a pas de bloc carnet sur la page sommaire (contrairement
aux sites de la galaxie). Ce n'est pas beaucoup mais ce peut être un
plus. Ou alors, comme "Derniers commentaires" une "nouvelles pages
Carnet".

comme il est dit dans la doc, le sceteur wiki est exclu de toutes les
boucles. Il n'est donc pas possible de construire de "bloc carnet" sur
la page sommaire. J'ai proposé sur l'article de cette contrib d'inclure
un critère dérogatoire pour pouvoir contourner ce probleme, mais il
faut laisser du temps au temps.

je connais :slight_smile: j'ai plein de trucs à déterrer des tiroirs "en cours de réflexion"

Quoiqu'il en soit cela ne change pas mon propos qui est que dans la
plupart des cas le passage par la case "page Carnet wiki" pour la doc
des plugins est à éviter car gaspillage d'efforts.

ça, y'a pas de solution technique ou alors un mail automatique : « Vous venez d'ouvrir une page du Carnet, si vous ne la remplacer pas dans les 10 jours par 5 articles sur Contrib, votre plugin sera forké. C. n'a pas voulu croire cet avertissement... »

quoi c'est nul ?

Claude

@+ NicolasR