Volontaire pour la doc

Salut,

J'ai enfin installé la dernière version de PluXml (5.1.6) pour réaliser un nouveau site
J'utilise régulièrement PluXml 5.0.2 sur deux sites et j'étais donc assez supris et content par le "nouveau" PluXml.
J'y ai trouvé pas mal de changements : une nouvelle présentation de l'interface administrateur, des ajouts pour la gestion SEO (qui manquaient cruellement : balise title, description), la gestion des plugins complètement changée, de nouveaux profils, ...
Les plugins sont particulièrement enthousiasmant avec de nombreuses participations de la communauté.
Cependant, il est dommage que la documentation ne soit plus vraiment à jour.
Le wiki est assez en retard et ne propose plus d'informations à jour pour l'installation de PluXml (ce qui serait un minimum). Les informations sur les plugins ne sont plus du tout à jour : il faut aller dans la partie Blog pour trouver un lien vers la liste des plugins sur Google.
J'ai un peu de temps en ce moment : je suis volontaire pour travailler sur le Wiki (ou autre chose) pour améliorer la documentation de PluXml.
A moins que cela ne soit un chantier déjà en cours par quelqu'un d'autre.
Bien entendu, j'aurai probablement besoin d'un peu d'aide ponctuellement pour des sujets que je ne maitrise pas (e.g. je n'ai trouvé aucune information sur les nouveaux profils).

Je suis prêt à discuter avec l'équipe qui gère le wiki, la documentation, et le site web.

Les points à améliorer, à mon avis:
- le wiki dans son ensemble : pour chaque page, au minimum indiquer la version concernée.
- reprendre les pages importantes du wiki
- le sous domaine "Ressources" ne liste que les thèmes il devrait aussi lister les plugins.
- certains thèmes sont indiqués pour la v 5.1.5 sur le site alors que c'est la v 5.1.6 qui est indiqué dans les commentaires
- le moteur de recherche du forum n'est pas toujours très pertinent, peut-être faudrait il en changer ?
- le moteur de recherche devrait être accessible par section du site ou par son ensemble (avec une liste déroulante).


A+,
L@u
«1

Réponses

  • StéphaneStéphane Member, Former PluXml Project Manager
    Bonjour
    - Pour ne pas partir dans tous les sens et vouloir tout faire sans rien faire, la documentation dans le wiki, partie "Installation et configuration" et "Utilisation" ont effectivement peut-être besoin d'être mises à jour, ne serait-ce qu'au niveau des impressions écrans.
    - je ne suis pas pour indiquer le n° de version car ça sera obligatoirement obsolète dès qu'une nouvelle version sortira et donc demandera de remettre à jour la doc.
    Ton aide est la bienvenue.

    Consultant PluXml

    Ancien responsable et développeur de PluXml (2010 à 2018)

  • Jerry WhamJerry Wham Member
    octobre 2012 modifié
    La doc devrait évoluer en même temps que les versions (je sais, plus facile à dire qu'à faire).


    Si le changement de version n'impacte pas sur la façon d'utiliser pluxml ou de charger un plugin, etc, il suffira juste d'indiquer le numéro des versions concernées.


    Ce n'est pas le fait d'indiquer ces numéros de version qui rendra la doc obsolète mais simplement le changement de version (qui s'en charge déjà).
  • HarukaHaruka PluXml Project Manager
    Effectivement, pour ne pas partir dans tous les sens, pourquoi ne pas créer un fichier (tableur Framacalc, par exemple), qui recense toutes les modifications / mises à jour à faire sur le wiki ?


    L'équipe de PluXml arbitre la pertinence des propositions et la communauté prend à sa charge les opérations de modification de la doc et du wiki.


    Le fichier permettrait de :
    - donner une visibilité des choses à faire
    - faire des propositions (en utilisant un onglet spécifique dans le fichier, par exemple)
    - alimenter un reporting des tâches en cours ("qui fait quoi et comment")


    Le forum pourrait dédier une section pour ces activités.


    Le but serait, de relancer les travaux communautaires et d'en multiplier les participants tout en garantissant la qualité des travaux.
  • Pas bête.
  • k610ik610i Member
    octobre 2012 modifié
    En tout cas, pour améliorer la visibilité de PluXml, un bon coup de rajeunissement (update du wiki, rajeunissement du template par défaut, réorganisation de la section Ressources avec une partie Plugin, etc) ne ferait vraiment pas de mal à PluXml.


    Je veux bien aider si besoin.
  • Stéphane,

    Alors qu'est-ce qu'on fait ?
    L'idée de P3ter (la feuille Framacalc pour coordonner les travaux) me parait bonne.

    Je rejoins Jerry (forcement, puisque j'ai suggéré l'idée) : tagué chaque page du Wiki par un numéro de version permettra de savoir facilement si la page est à jour ou pas.
    De toute manière, effectivement, à chaque nouvelle version, il faudrait faire le tour du Wiki pour savoir si chaque page est toujours d'actualité où si elle doit être modifié.
    Le système de tags permet aux lecteurs de savoir si la page a été modifié ... et si elle ne l'est pas de la corriger.

    Cependant, cela veut peut-être dire qu'il va falloir gérer plusieurs versions d'une même page : en effet, certains utilisateurs peuvent avoir besoin de la doc (i.e. du Wiki) d'anciennes versions car c'est la version qu'ils utilisent.
    On peut même supposer que certains utilisateurs désirent installer une ancienne version pour utiliser d'anciens thèmes.

    A voir !
  • StéphaneStéphane Member, Former PluXml Project Manager
    Il n'est pas nécessaire de taguer les pages du wiki. Il y a une menu historique qui permet de savoir quelles modifications ont été faites sur la page en cours de visualisation. Je préfère que les modifications soient faites directement dans le wiki, pour éviter un travail en double qui obligerait après de ressaisir tout dans le wiki. Autant faire bien dès le 1er coup. De plus je ne souhaite pas que la structure du wiki soit modifiée. croque-Odille a fait un énorme travail dernièrement pour remanier le wiki (voir http://forum.pluxml.org/viewtopic.php?id=3422). Maintenant il est vrai que des parties demandent a être mise à jour surtout la partie installation/utilisation ce qui pourrait être fait en 1er.

    Consultant PluXml

    Ancien responsable et développeur de PluXml (2010 à 2018)

  • Stéphane,
    OK, tu ne veux pas taguer les pages du Wiki. Je ne pense pas que les utilisateurs aillent jamais voir dans l'historique pour savoir si les pages sont à jour avec la version ou pas ... mais bon, c'est comme tu veux.


    Je ne comprends pas :
    Stéphane a écrit:
    Je préfère que les modifications soient faites directement dans le wiki, pour éviter un travail en double qui obligerait après de ressaisir tout dans le wiki. Autant faire bien dès le 1er coup.
    Personne n'a jamais parlé de faire un travail en double ? ! ?


    Je n'ai pas l'intention de changer la structure du Wiki.
    Je veux juste poser la question de la gestion des versions (et de leurs supports) de PluXml.
    Aujourd'hui, je suspecte qu'il y a de nombreuses versions différentes de PluXml en service. On peut télécharger des thèmes d'anciennes versions (par contre pas le reste, plugins ?). Donc, doit-on conserver les informations pour différentes versions de PluXml (par exemple, la liste des plugins pour des versions antérieures à la dernière version) ? Ou bien, le wiki ne concerne-t'il que la dernière version ?


    Est-ce qu'on fait un tableau pour coordonner les travaux ?


    Bonne soirée.
  • StéphaneStéphane Member, Former PluXml Project Manager
    Autant pour moi j'ai mal compris l'utilisation du fichier Framacalc. Ok pour moi ça sera pratique en effet si vous voulez suivre et coordonner ce qu'il y a à faire.
    Le tag des pages me semble justifié que pour les parties qui parlent plugins, modifs de code, etc, pour savoir à quelle version de PluXml on se réfère. Donc là oui. En gros sur tout ce qui vient se greffer autour de PluXml et qui n'est pas "officiel".
    Pour la partie purement installation/utilisation c'est "sensé" être toujours à jour en référence à la dernière version, donc le tag on peut s'en passer ici.
    Le plan d'attaque serait donc d'écrire quelque part (framacalc ça me va, c'est pas les solutions qui manquent) et de lister ce qu'il y a à faire, que la personne qui prévoit ou qui est en train de travailler sur un sujet le mentionne (pour éviter d'être plusieurs à faire le même travail) et qu'une seule personne supervise et valide l'ensemble des mises à jour (relecture finale) avant de clore une action dans le fichier de suivi.
    Reste plus qu'à définir les rôles en fonction des personnes qui se proposent volontaire :p

    Consultant PluXml

    Ancien responsable et développeur de PluXml (2010 à 2018)

  • k610i a écrit:
    En tout cas, pour améliorer la visibilité de PluXml, un bon coup de rajeunissement (update du wiki, rajeunissement du template par défaut, réorganisation de la section Ressources avec une partie Plugin, etc) ne ferait vraiment pas de mal à PluXml.


    Je veux bien aider si besoin.



    +1 Je veu bien aider aussi.
  • HarukaHaruka PluXml Project Manager
    Cool :)

    Bon comme j'ai proposé l'utilisation d'un fichier de suivi, je me porte volontaire pour essayer de préparer/organiser tout ça. Je vous fait un retour sur le forum dans la journée de samedi ;)
  • Cool ! C'est parti ... enfin bientôt !
  • HarukaHaruka PluXml Project Manager
    Hello,


    J'ai préparé un fichier, le voici : http://bit.ly/R1ddnu


    J'ai finalement choisi de partir sur Google Drive, car Framacalc ne permet d'ajouter des feuilles au classeur (onglets). Alors que je souhaitais une feuille pour les "en cours" (le suivi) et une autre pour les "propositions".


    Donc, dans la première feuille, il y aura toutes les tâches validées par Stéphane. Le statut indique si la taĉhes est :
    - en attente (soit parce qu'elle ne peut pas démarrer tout de suite, soit parce que personne ne c'est encore porté volontaire pour y travailler)
    - en cours (une personne c'est porté volontaire)
    - terminé (à supprimer du fichier ?)


    Lorsqu'une tâche est en cours indiquez, dans la colonne Suivi, où vous en êtes, si vous avez besoin d'aide, etc.


    Dans l'onglet Proposition, tout le monde peut librement ajouter une ligne est faire une proposition, d'ajout, suppression, mise à jour, etc. Mais toujours autour du wiki et des ressources. Vous pouvez bien sûr discuter de vos propositions sur le forum.


    Dans les colonnes Responsable et Auteur, indiquez le même pseudo que sur le forum (pour pouvoir vous contacter si besoin).


    J'ai mis quelques lignes d'exemples.



    Tout ceci, bien entendu, si Stéphane est d'accord.



    Par ailleurs Stéphane, je te propose la création d'un poste de Community Manager pour toute la partie communication autour de PluXml (le blog, Twitter, le fichier de suivi, etc). Tout simplement parce que je pense que PluXml a besoin d'un regain de dynamisme de ce coté et je pense que l'équipe à déjà beaucoup à faire avec les versions de PluXml, pour s'occuper en plus de la communication et de la communauté.
  • Personnellement la première chose qui me vient à l'esprit serait de créer une nouvelle partie dans le site où l'on recenserai tous les plugins disponibles.
  • StéphaneStéphane Member, Former PluXml Project Manager
    P3ter a écrit:
    Tout ceci, bien entendu, si Stéphane est d'accord.
    ça marche.
    P3ter a écrit:
    Par ailleurs Stéphane, je te propose la création d'un poste de Community Manager pour toute la partie communication autour de PluXml (le blog, Twitter, le fichier de suivi, etc). Tout simplement parce que je pense que PluXml a besoin d'un regain de dynamisme de ce coté et je pense que l'équipe à déjà beaucoup à faire avec les versions de PluXml, pour s'occuper en plus de la communication et de la communauté.
    Tu te proposes pour ce poste ?

    Consultant PluXml

    Ancien responsable et développeur de PluXml (2010 à 2018)

  • +1 pour le Community Manager. Qui est volontaire?
  • HarukaHaruka PluXml Project Manager
    Stéphane a écrit:
    Tu te proposes pour ce poste ?
    Jos a écrit:
    +1 pour le Community Manager. Qui est volontaire?

    Oui, je suis volontaire ;)
  • J'ai fait deux propositions dans le tableau (depuis 2 jours) : j'attends la suite.
  • HarukaHaruka PluXml Project Manager
    Hello,


    ComputingFroggy merci pour ta contribution, j'ai bien pris note de t'es 3 propositions :
    - maj page "Installation"
    - maj page "Plugins non officiels"
    - créer une section "Anciennes Versions"


    Stéphane je te laisse statuer sur ces trois propositions et ensuite je mettrai le fichier à jour en conséquences ;)
  • StéphaneStéphane Member, Former PluXml Project Manager
    Ok pour moi


    Pour les impressions écrans qui sont obsolètes et à remplacer dans le wiki
    - nommer le nouveau fichier avec le même nom que l'image existante (voir le nom du fichier dans le code de la page wiki)
    - m'envoyer le(s) fichier(s) par mail. Je le(s) déposerai par ftp sur le wiki. ça écrasera les anciens fichiers et la mise à jour sera faite.


    Pour les nouveaux fichiers images, me les envoyer par mail. Je le(s) déposerai par ftp sur le wiki dans le dossier images.

    Consultant PluXml

    Ancien responsable et développeur de PluXml (2010 à 2018)

  • Pour la page truc et astuces, je propose de mettre que les astuces qui n'ont pas de plugin (et de ne pas mettre celles qui ont un plugin), car çà fait doublon avec les pages plugins officiel et non officiel. Qu'en pensez-vous?
  • StéphaneStéphane Member, Former PluXml Project Manager
    Jos a écrit:
    Pour la page truc et astuces, je propose de mettre que les astuces qui n'ont pas de plugin (et de ne pas mettre celles qui ont un plugin), car çà fait doublon avec les pages plugins officiel et non officiel. Qu'en pensez-vous?

    ok. il y aura moins de confusion comme ça

    Consultant PluXml

    Ancien responsable et développeur de PluXml (2010 à 2018)

  • C'est ce que je me disai aussi ;)


    Je réfléchirai là dessus pour trier et je te tiendrai au courant avant toute modifs.
  • HarukaHaruka PluXml Project Manager
    Ok Jos merci pour tes contributions, je mettrai à jour le fichier de suivi.
    Si tu souhaites contacter Stéphane par mail, peux-tu me mettre en copie stp ?
  • Ok pas de soucis. Je m'occuperai du trie la semaine prochaine.
  • @Stéphane, @P3ter

    Je viens de vous envoyer un mail où vous trouverez un pré-trie pour la page trucs et astuces.
  • Bon j'ai fais les modifications sur la partie astuces dans le Wiki. J'ai conservé l'ancienne version au cas où.
  • HarukaHaruka PluXml Project Manager
    Merci beaucoup pour ta contribution. Comme on l'avait décidé, j'ai supprimé l'astuce pour Gravatar puisqu'il existe le plugin hamGravatar.
  • C'est une bonne chose de faîte. Parcontre, faudra supprimer les pages obsolètes qui sont en dur dans le Wiki (vu que je n'y ai pas accès). J'ai la liste au cas ou tu en aurais besoin.
  • @P3ter : je viens de proposer deux nouvelles modifications que je me propose de faire sur le wiki. Peut-tu y jetter un oeil pour me dire ce que tu en pense?
Connectez-vous ou Inscrivez-vous pour répondre.