doc plugins

Général
1

Bonjour,

petite proposition de structure d'une doc plugin

1/ titre, auteur, concept, version actuelle, licence, langue d'origine, traductions disponibles

2/ impact sur la base de données
nouveaux formulaires, nouveaux modèles, nouveaux squelettes
nouvelles balises, nouvelles boucles, filtres et paramètres
nouvelles fonctions éventuellement réutilisables
fichiers/fonctions surchargées

3/ installation/configuration

4/ utilisation dans le backoffice

5/ utilisation sur le site public

6/ conseils squelettes, boucles, etc.

8/ doc du CSS éventuel

9/ to do et évolution souhaitée

10/ une liste de tickets-bug sur le plug ...

11/ les trucs des utilisateurs (trucs validés !!!)

Le concepteur DOIT valider (même si on aide à la rédaction).

???

Bien à vous
RB

2

-----Message d'origine-----
De : spip-bounces@rezo.net [mailto:spip-bounces@rezo.net] De
la part de RB
Envoyé : mercredi 6 septembre 2006 17:31
À : spip@rezo.net
Objet : [Spip] doc plugins

Bonjour,

petite proposition de structure d'une doc plugin

A envoyer à spip-zone.

3

Très bien cette proposition.

Juste une précision sur la chaine de production d'un plugin.

1) Le developpeur envoi le code sur spip-zone
2) les testeurs le test après l'avoir remarqué sur spip-zone
http://trac.spip.org/trac/spip-zone/log/ et téléchargé ici :
Connexion · GitLab
3) quand c'est utilisable il faut entrer le plugin sur la page des plugins (wiki)
http://trac.spip.org/trac/spip-zone/wiki/LesPlugins
4) et même rédiger une page exprès avec les détails par exemple
http://trac.spip.org/trac/spip-zone/wiki/SpipForms
5) Un beau jour le plugin devient stable, et il faut publier un "vrai" article sur spip-contrib, ou sur un site à part, part exemple http://bloog.net/spip-listes.

Quand vous vous retrouvez face à un plugin, vous pouvez intervenir sur toutes ces phases. Par exemple si vous le trouvez en phase 2) et que ca marche vous pouvez vous occuper de la phase 3) etc.

Parfois les devs gerent toutes ces phases seuls, mais le plus souvent ils ont besoin que vous preniez le relais, si vous vous en sentez capables, si cela vous tente de participer à votre niveau, quel qu'il soit.

@+
BoOz

RB a écrit :

Bonjour,

petite proposition de structure d'une doc plugin

1/ titre, auteur, concept, version actuelle, licence, langue d'origine, traductions disponibles

2/ impact sur la base de données
nouveaux formulaires, nouveaux modèles, nouveaux squelettes
nouvelles balises, nouvelles boucles, filtres et paramètres
nouvelles fonctions éventuellement réutilisables
fichiers/fonctions surchargées

3/ installation/configuration

4/ utilisation dans le backoffice

5/ utilisation sur le site public

6/ conseils squelettes, boucles, etc.

8/ doc du CSS éventuel

9/ to do et évolution souhaitée

10/ une liste de tickets-bug sur le plug ...

11/ les trucs des utilisateurs (trucs validés !!!)

Le concepteur DOIT valider (même si on aide à la rédaction).

???

Bien à vous
RB