Appel à volontaires pour la future documentation de PluXml

HarukaHaruka PluXml Project Manager
MAJ
La documentation est terminée et sera prochainement disponible avec la nouvelle version de PluXml.
[ins]L'appel à volontaires est désormais clos.[/ins]




Bonjour à tous chers communautaires.

Rédiger la documentation de PluXml est un travail d’envergure qui demande du temps et de la disponibilité et l’équipe de PluXml a besoin de votre aide et de votre contribution pour participer à l’élaboration de ce guide utilisateur.

Je vous invite donc à lire cet article sur notre recherche de personnes motivées pour nous aider à rédiger la future documentation de PluXml.

Si vous avez des questions, n’hésitez pas à les poser ici sur le forum.


Merci,
P3ter et Bankai
«1

Réponses

  • s'il faut la mettre en page pour sortir un PDF, je suis là {)
  • alpaphalpaph Member
    Bonjour,
    Je veux bien contribuer mais mes compétences techniques sur Pluxml sont proches de 0. Par contre, si besoin, je peux faire le relecteur ... ????
  • Bonjour,

    Que faut-il comme compétence pour la documentation ? core / plugin / thèmes ...
    (en me remettant à jour je devrais pouvoir aider)

    Comment est faite la doc ? latex sur git ?
  • HarukaHaruka PluXml Project Manager
    Pas besoin de compétences technique, la documentation et orientée utilisateur plus que développeur et reprend toute la partie installation, configuration et utilisation de PluXml.


    Comme expliqué sur le blog, la doc est rédigé sous Google Document/Drive pour que se soit accessible par tous (c'est plus simple de rédiger sous GDrive que d''utiliser latex et git).
  • Jerry WhamJerry Wham Member
    mars 2013 modifié
    Pourquoi utiliser deux applications fermées (word et Google) pour diffuser des informations concernant une application libre? C'est pas comme s'il n'existait pas des alternatives (libreOffice et http://framapad.org/)
  • HarukaHaruka PluXml Project Manager
    Oui je sais bien, mais c'est par commodité qu'on travail avec les applications Google pour cette première version de la documentation. Quand la v1 serra terminé, j'ai pensé à en faire une version latex dont on mettra les sources sur le Github du projet. Mais travailler dès le début avec git et latex c'est exclure des volontaires tous ceux qui ne sont pas familier avec ces outils. Alors que pour cette première version on a besoin du maximum de personne.
  • JosJos Member
    Lorsque la doc sera terminé, il y aura toujours le wiki ou non? Sinon, je suis volontaire...
  • StéphaneStéphane Member, Former PluXml Project Manager
    @Jos: oui

    Consultant PluXml

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

  • JosJos Member
    Merci Stéphane.
  • zozzoz Member
    Bonjour,

    Je viens de m'inscrire pour vous aider. :cool:

    cordialement,
    zoz
  • GzygGzyg Member
    +1 pour Jerry Wham...

    Et pourquoi ne pas utiliser tout simplement un vrai wiki comme dokuwiki qui conviendrait autant à la doc utilisateur qu'à la doc développeur ?

    Libre et sans base de données, ça vous rappelle rien ? ;)


    à plus,

    Gzyg
  • JosJos Member
    Gzyg a écrit:
    +1 pour Jerry Wham...

    Et pourquoi ne pas utiliser tout simplement un vrai wiki comme dokuwiki qui conviendrait autant à la doc utilisateur qu'à la doc développeur ?

    Libre et sans base de données, ça vous rappelle rien ? ;)


    à plus,

    Gzyg


    Par la suite il y aura un wiki.


    Parcontre j'ai une question : il y aura t'il une trame pré-établie pour que les volontaire suivent une trame afin que çà ne parte pas dans tous les sens?
  • StéphaneStéphane Member, Former PluXml Project Manager
    @Jos: oui. cf table des matières de la doc en construction

    Consultant PluXml

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

  • JosJos Member
    Merci Stéphane ;)
  • Je reviens à la charge, mais sachant comment google a fermé son lecteur rss, pourtant utilisé par quantité de personnes, il peut arriver la même chose avec les documents, ou l'hébergement de code (cf plugins)...
  • JosJos Member
    Google fait son grand ménage depuis quelques temps, mais pour Google Documents, je ne pensez pas qu'ils le ferment.
  • GzygGzyg Member
    Le problème n'est pas que Google ferme ou ne ferme pas un service, le problème est qu'il peut le faire sans se soucier de ton avis.

    Une doc est quelque chose d'à la fois essentielle, fragile et qui doit même survivre à ses rédacteurs (c'est une image) : des solutions opensource et pérennes existent, essayons de les utiliser... :)


    à plus,

    Gzyg
  • Gzyg a écrit:
    Le problème n'est pas que Google ferme ou ne ferme pas un service, le problème est qu'il peut le faire sans se soucier de ton avis.

    Une doc est quelque chose d'à la fois essentielle, fragile et qui doit même survivre à ses rédacteurs (c'est une image) : des solutions opensource et pérennes existent, essayons de les utiliser... :)


    à plus,

    Gzyg
    Bien dit.
  • bankaibankai Member
    Ont ne peux pas être tous sur le même front ^^ je suis un utilisateur à 100 % Google, je ne pense pas que durant les 10 prochaines année google ferme Drive et ses ad-dons.
    Concernant le flux rss de google, il était vieillissant.

    Le choix des outils google se porte sur le faite que l'équipe travail sous Gmail pour être en harmonie et correspondre en toute simplicité, rapidement.

    Github est utilisé pour les sources, les versions dev .

    Sinon la doc avance et c'est ça le principal :)
  • bankai a écrit:
    Ont ne peux pas être tous sur le même front ^^ je suis un utilisateur à 100 % Google, je ne pense pas que durant les 10 prochaines année google ferme Drive et ses ad-dons.
    Concernant le flux rss de google, il était vieillissant.

    Le choix des outils google se porte sur le faite que l'équipe travail sous Gmail pour être en harmonie et correspondre en toute simplicité, rapidement.

    Github est utilisé pour les sources, les versions dev .

    Sinon la doc avance et c'est ça le principal :)
    Il était en aucun cas vieillissant, mais on ne va pas s'enfoncer dans un débat qui n'a pas lieu d'être ici.


    Ma remarque voulait juste soulever le fait qu'on ne peut pas leur faire confiance pour la pérennité du projet. C'est tout. Et peut tout à fait correspondre en harmonie et simplement et rapidement en utilisant d'autres outils, plus libres.
  • jack31jack31 Member
    C’est vrai que les arguments "contre" se tiennent et j'y plussoie volontiers.


    Toutefois, il faut remarquer que l'outil est pratique pour ce genre d'exercice, qu'il permettra de sortir des pdf rapidement, et que ce n’est jamais qu'un outil choisi sans doute par le staff pour sa simplicité de mise en oeuvre.


    Peut-être n'a-il pas (le staff) nécessairement envie d'installer et maintenir un truc de plus (hors Pluxml) d'autant plus qu'il semble qu'il ait d'autres chats à fouetter. ;)


    Ce qui m'intéresse davantage, c’est de savoir comment le bébé final va apparaître sur le site principal et comment il va être complété et mis à jour (qui et avec quel droits d'édition) car l'évolution permanente de Pluxml nous fait prévoir bien du plaisir.
  • JosJos Member
    Ayant commencé à rédiger avec ce système, je trouve çà plutôt pratique. Après, lorsqu'on aura finit, le problème ne se posera plus, c'est juste le temps qu'on finisse.
  • HarukaHaruka PluXml Project Manager
    Bonjour à tous,


    La documentation est presque terminée, il ne reste que quelques parties à relire et des remarques à intégrer. La version finale devrait donc arriver très bientôt, grâce à l'efficacité des participants un grand merci à eux !


    Il y aura un article sur le blog de PluXml pour l'occasion.
  • AirWAirW Member
    Oui merci !
  • zozzoz Member
    P3ter a écrit:
    Il y aura un article sur le blog de PluXml pour l'occasion.

    Wahou, j'espere qu'il y aura du champagne aussi :-)
  • k610ik610i Member
    Je n'ai pas vraiment aidé, je m'en veux un peu de ne pas prendre ce temps là.
    Dans tous les cas, bon travail ! :)
  • P3ter a écrit:
    Bonjour à tous,


    La documentation est presque terminée, il ne reste que quelques parties à relire et des remarques à intégrer. La version finale devrait donc arriver très bientôt, grâce à l'efficacité des participants un grand merci à eux !


    Il y aura un article sur le blog de PluXml pour l'occasion.

    Je ne suis pas aussi optimiste que toi. Il y a encore pas mal de boulot si l'on veut sortir une doc de qualité.
    Certains articles sont à reprendre et la relecture n'est pas encore finie.
  • HarukaHaruka PluXml Project Manager
    Jerry Wham a écrit:
    Certains articles sont à reprendre et la relecture n'est pas encore finie.

    De quels articles est-ce que tu parles ?
  • Celui sur la redaction d'un article par exemple car il mélange le fonctionnement de pluxml avec celui de certains plugins. Et il y a encore plein de fautes d'orthographe et des phrases dont la tournure est à revoir.
  • Pour les plugins, on en a parlé dans les commentaires et le staff va supprimer (du moins j'ai proposé) les mentions de ceux dont il est inutile de parler dans la doc.


    Pour la tournure des phrases, il faut proposer mieux quand on a une idée et pour les fautes d'orthographes, pas de quartier. Éradication immédiate sans sommation dés qu'on en repère une. ;)
Connectez-vous ou Inscrivez-vous pour répondre.