CodingLille

Notes en vrac sur la journée Coding Party à Lille

Intro Fil :

  • beaucoup de mouvement dans le dev récemment
  • pression sur les mainteneurs principaux
    • debug
    • sécurité
  • du coup, doc utillisateur suit pas, et ça qualité baisse
    • => force de spip (accessible au débutant) diminue
  • il faut donc documenter aussi bien coté utilisateur que coté codeurs (plugins)
  • par ailleurs, plugins devrait permettre d’ouvrir le code afin d’avoir plus de contributeurs
    • mais il faut que les contributeurs ne fassent pas que du code, il faut aussi documenter

=> concrètement ? repenser la doc autrement ?

problème actuellement : la pérenité de la doc technique (orga des fichiers ...)
d’un autre coté, certains “concepts” ne bouge pas profondément et sont plus pérennes à documenter

-  présentation du code, documentation en live ... voir doc.spip.org

-  discussion sur la zone : comment rendre la zone plus accessible ? actuellement, c’est un trac en vrac, et un “non technicien” s’y perd. Comment améliorer ça ?

  • utiliser le wiki ? ou plutôt un spip dans lequel il y ait des articles présentant des divers projets présents dans le trac.
  • remarque : la zone, à l’origine, avait pour but de centraliser le code des contribs. Il faudrait recentrer sur ce but afin que la doc du code présent sur la zone soit faite sur spip-contrib.

-  libérons le memento !

  • le memento, publié par eyrolles, et écrit par Booz et Mortimer, est un dépliant plastifié récapitulant les principaux éléments de syntaxe de spip.
  • pratique car petit, café-proof, souvent plus facile à avoir sous la main qu’un web.
  • c’est 5€, et ça se met pas à jour tout seul, et c’est que en français
    => idée : reprendre le principe mais le générer automatiquement depuis les spip.net/@ par exemple, et rendre le pdf résultant dispo.

comment ?

  • un article par section du memento, avec une structure rigide permettant de le convertir en pdf joli ?
  • des mots clés (comme les @ actuels) avec un titre se référant à un fichier de langue via un [(#TITRE|_T)] et un fichier de langue contenant la définition ?
    dans ce cas, on n’a qu’un niveau d’arbo alors qu’avec la première solution, on peut rubriquer.

qui fait quoi ?

  • sortir un dump de spip.net pour avoir une base de travail qu’on puisse bricoler dans son coin
    • il est là : spip.net/dump.xml.gz et les squelettes actuels sont sur la zone.
  • coder des trucs sur la zone :-) histoire de voir quelle allure ça peut avoir

updated on 4 March 2007

Discussion

Aucune discussion

Comment on this article

Who are you?
  • [Log in]

To show your avatar with your message, register it first on gravatar.com (free et painless) and don’t forget to indicate your Email addresse here.

Enter your comment here

This form accepts SPIP shortcuts {{bold}} {italic} -*list [text->url] <quote> <code> and HTML code <q> <del> <ins>. To create paragraphs, just leave empty lines.

Add a document

Follow the comments: RSS 2.0 | Atom