[spip-dev] Une proposition de plus pour la doc...

From : eric@... , the 18th novembre 2011 11:45

Hello, Suite à une discussion avec Romy et Mathieu autour de pâtes bien goutues, voilà un peu ce que pourrait devenir la doc de SPIP en 2050 (je décris les sites sans aucun ordre précis)  : *1) doc.spip.net : * -> Il abrite actuellement une compilation plus ou moins commentée des fonctions php du code de SPIP. Une idée serait de le restructurer un peu à la manière de php.net et de lui faire héberger le langage SPIP et les API php offertes par SPIP. On pourrait y mettre : - l'explication du langage SPIP, donc en particulier le glossaire de spip.net - l'API SQL (qui est la seule a priori qui soit formalisée) récupérée de programmer;spip.net - les filtres réellement utilisables et "maintenus" par SPIP comme une vraie API php. Cela demandera donc de définir la partie privée et publique du code SPIP en ayant l'intérêt de statuer sur ce qui est utilisable par les plugins ou pas. Ces API pourraient être dès lors générés par du phpdoc comme php.net que je trouve extrêmement pratique à utiliser. *2) programmer.spip.net * -> Il aborde beaucoup d'aspects de dev mais pas assez en profondeur. Mathieu m'avait posé la question si j'utilisais souvent le site et pour quel besoin : j'ai répondu l'API SQL ou les autoritsations principalement. En effet, je pense que programmer n'est pas assez tourné vers le "comment faire", les mécanismes de mise en oeuvre complets (créer un objet éditorial, créer un squelette...). Je trouve qu'il faudrait plutôt lui donner cette orientation "tuto" que l'on retrouve par exemple sur magraine.net. Et de ce point de vue là j'y mettrais autant les mécanismes de dev pour les plugins que pour les squelettes de l'espace public ou privé (donc une partie de spip.net). En deux mots, doc,spip.net serait la référence du framework spip et programmer;spip.net la mise en oeuvre pratique de ce framework. *3) spip.net * -> J'ai toujours eu plus de mal à l'appréhender car je n'utilise que le glossaire que je propose de déporter vers doc.spip.net Si les deux autres sites proposent une doc de dev (plugins ou squelettes), spip.net doit héberger la doc utilisateur. Donc le point d'entrée est à mon avis le profil de l'utilisateur : rédacteur, administrateur, webmestre. Et ainsi aborder les actions de chaque utilisateur pour savoir comment elle se déclinent dans la version de spip choisie (rédiger un article donc les raccourcis spip...). Je garderais l'histoire de spip et aussi un rapide tour d'horizon des notions de base sans que ces chapitres soient un passage obligé pour le visiteur (c'est le cas d'ailleurs aujourd'hui). ++ Eric