Forum Programmation.autre Polydoc, la documentation globale et libre

Posté par  .
Étiquettes : aucune
0
18
juin
2007
Bonsoir à tout le monde :)

Je suis un nouvel inscrit sur DLFP, même si je fréquente ce site depuis un moment déjà. Veuillez d'avance m'excuser, s'il vous plaît, si mon post est dans le mauvais forum ou si sa nature n'est pas admise (on pourrait dire que c'est de la publicité).

Nouvellement, sur Internet, il s'est créé un site très ambitieux : Polydoc. Polydoc a pour objectif d'être une documentation sur la programmation :
- globale (couvrant tous les langages - ou presque, une demande suffit pour en voir un ajouté)
- en wiki (pour assurer une exhaustivité maximale)
- libre (toutes les contribtions sont sous licence GNU GFDL)
- et en français

Tous ces objectifs sont éclaircis sur la page d'accueil de Polydoc, disponible à http://www.polydoc.org/

Polydoc aurait grand besoin d'un coup de pouce pour faire sa place et pour que son contenu aie une réelle qualité et quantité (tout de même 433 pages à l'heure où j'écris).
Je sollicite votre aide, programmeurs de tous langages ayant un peu de temps et d'envie, pour créer quelques pages ou en rectifier certaines, ou même distribuer le lien.
sur le forum, rien que le fait d'envoyer les gens qui ont des problèmes sur une fonction vers Polydoc plutôt que vers la doc PHP (par exemple) serait très utile et appréciable !

En espérant que ce post pourra vous donner envie de participer à un projet qui a de l'avenir, et en espérant qu'il ne soit effacé par un modérateur pour cause de publicité, bonsoir :o)
  • # et pourquoi...

    Posté par  (site web personnel) . Évalué à 7.

    Et qu'est-ce qui nous motiverait à envoyer quelqu'un vers polydoc plutôt que vers les docs officielles à priori plus complètes?
    • [^] # Re: et pourquoi...

      Posté par  . Évalué à 2.

      je n'aurais pas dit mieux mais comme je ne peux pas te plusser, ben je met un

      +1

      en reponse ;-)
    • [^] # Re: et pourquoi...

      Posté par  . Évalué à 1.

      Salut :)

      Tout simplement, les docs plus officielles ou les très rares docs alternatives sont :
      - soit pas en wiki
      - soit déjà complète
      - soit en anglais
      - parfois même pas libre

      Quand même, imaginez avoir toutes les docs de tous les langages réunies, en français, libres, en wiki, et avec une structure identique, ce serait le pied non ?
      Et ben c'est exactement l'objectif de Polydoc.
      • [^] # Re: et pourquoi...

        Posté par  (site web personnel) . Évalué à 3.

        Bon étant un connaisseur (enfin pas mal) de php et sql, je pense que ton projet a pas vraiment d'intérêt...

        Oui je sais c'est rude...

        Enfin une doc similaire a la doc officielle de php n'a aucun intérêt (le seul serait de traduire les commentaires et de virer ceux en double).

        Par contre il serait nettement plus intéressant que vous repreniez des documentations et articles sur php en anglais pour en faire une bonne traduction.

        Par exemple :
        - Conception MVC
        - Factory, Singleton
        - Création d'objet
        - Utilisation de classe d'abstraction : PDO, MDB2, etc...
        - Conception de base de donnée (quel type, quelle clef, etc)

        Parce que documenter l'api bon ben ça a pas vraiment d'intérêt...
        (autant aller faire les bugs report pour le faire ajouter dans la doc officielle)
        • [^] # Re: et pourquoi...

          Posté par  (site web personnel) . Évalué à 2.

          J'ai oublié un petit truc.

          Quand tu auras fait ces changements, si tu veux facilement monter dans les stats google (car cela aura un intérêt alors) :
          - met des liens direct en page d'accueil vers une full liste des articles (sinon google moulinera pas ton site)
          - met tes articles avec le titre dans l'url si tu peux le faire

          Une fois ces changements cosmétiques fait pour ton site, reviens ici et fait un journal public !!!
          (pas un forum qui disparaît super vite et fera pas monter ton rang)

          Bon sinon dans les sites avec du contenu sympa il y a le http://www.siteduzero.com/ mais il n'est pas assez poussé je trouve.

          Après si tu veux trouver des articles de qualité va chez ibm, c'est en anglais et très haut niveau, mais toujours très intéressant :
          http://www.ibm.com/developerworks/search/searchResults.jsp?s(...)
          http://www.ibm.com/developerworks/search/searchResults.jsp?s(...)

          Article sur les modèles de conceptions :
          http://www.ibm.com/developerworks/opensource/library/os-php-(...)

          Sinon y a pas mal de truc dans le site de zend, mais c'est pareil que chez ibm, une quantité d'article en anglais de très haut niveau dans un univers de documents pas tous très intéressant...
          • [^] # Re: et pourquoi...

            Posté par  . Évalué à 1.

            Bonjour,

            Tout d'abord ce n'est pas mon site. L'admin s'appelle Elentar, moi je ne suis que membre. Ensuite, concernant www.siteduzero.com, en vérité 90% des membres actuels de Polydoc viennent de ce site ;)
            Tu propose de documenter les bibliothèques additionnelles : c'est prévu, faisable je crois, pour l'instant il n'y a qu'un personne qui a commencé à documenter Qt... Mais c'est un travail titanesque, et pour documenter une bibliothèque je pense qu'il vaut mieux avir documenté la base du langage d'abord, c'est plus logique.
            L'intérêt de Polydoc, c'est l'exhaustivité. A terme, on pourrait rechercher des informations sur n'importe quelle fonction/classe/constante/biblitohque/ce-que-vous-voulez dans n'importe quel langage !
            Ensuite, Polydoc est une documentation, pas un recueil de tutoriaux ou cours.
            Pour tes conseils sur le référencement google, je^prends, et j'envoie le lien à l'admin, merci.

            Pour documenter une bibliothèque (ou plusieurs), il faut du monde, beaucoup de gens qui la connaissent assez bien pour la documenter. D'où mon post : venez tous :p !
            • [^] # Re: et pourquoi...

              Posté par  (site web personnel) . Évalué à 3.

              Laisse moi le répéter !

              Documenter php ou QT n'a AUCUN intérêt !!!

              Pour php ça n'a aucun intérêt car la doc existe déjà et est déjà bien complète.
              (honnêtement je n'ai pas trouvé de trou)
              Ensuite leur système de recherche marche déjà très bien !
              Exemple : http://fr.php.net/ksort
              (ksort étant un nom de fonction)

              Pour qt c'est la même chose, a part que la traduction de la doc en français est peut-être non disponible.
              (Donc il suffit de reprendre la doc de trolltech et de la traduire + ré-envoyer)

              Pour le reste je sais pas, mais en tout cas pour php et qt il n'y a pas de grand intérêt.

              En fait la doc des fonctions de php elle est disponible un peu partout, en revanche ce qui manque, c'est des guides par la pratique de l'utilisation de fonctions avancées.
              • [^] # Re: et pourquoi...

                Posté par  . Évalué à 1.

                Peut être que l'exemple de Qt n'était pas le meilleur, mais il existe forcément plein de bibliothèques qui ne sont pas documentées. L'intérêt de Polydoc est qu'à terme il faudrait qu'il y ait un maximum de bibliothèques, tout étant centralisé. On pourrait dans une page de Qt parler de GTK, et en voir dans GTK, la présentation serait la même que pour Qt. Ce serait expliqué de la même manière.

                Autre exemple, sur Polydoc on compte documenter par exemple l'OCaml. Je ne sais pas s'il existe une doc en ligne français ou pas, mais imaginons que lorsqu'on explique un concept propre à OCaml, on parle de l'équivalence à Haskell ou Ruby. On suivrait le lien, et sans changer de site, ni de structure, ni rien du tout, on pourrait voir la correspondance avec l'autre langage.

                Dans la doc PHP, par exemple, si tu trouve une erreur, pour la rectifier il faut envoyer un mail à un admin, pour qu'il édite en circonstance, etc. C'est pas pratique. Les exemples, l'interface et les commentaires sont en anglais, aussi. L'ergonomie est plus que perfectible, encore plus lorsqu'on est débutant, je trouve (par exemple, si on cherche une fonction sur la manipulation des chaînes de caractères, mais qu'on ne connait pas son nom, on est obligé de toutes les lire une par une pour voir si c'est celle désirée, encore faut-il avoir trouvé la catégorie "Strings" - pas évidente pour un nouveau).
            • [^] # Re: et pourquoi...

              Posté par  . Évalué à 2.

              elles sont DEJA documentées... et traduites 36 fois

              si vous voulez être utiles, proposez du contenu inédit, que ça soit des traductions de docs ou howto en anglais,

              (au pif, des sites dans le genre http://www.howtoforge.com )

              ou du contenu existant mais avec une autre organisation, sous une nouvelle forme beaucoup plus orientée utilisation qu'une bete liste interminable de noms de fonctions sans aucun lien entre elles

              par exemple, au lieu de raisonner langages puis type de fonctions (ou bibliothèques), faites des guides, montrez donc comment utiliser la même librairie (au pif, libgd) ou des fonctions similaires (les traitements sur les chaines, les regexps, ou l'accès à mysql) avec tous les langages d'un coup... par exemple perl python php et compagnie au lieu de juste un.

              ou encore faites le tour d'internet et repérez et adaptez quelques resources indispensables mais pas forcément traduites récemment, peut-être pas les RFC mais au pif les listes des pays correspondant aux TLD (la version exhaustive qui fait plus de 240 lignes, hein) ou la liste des numéro de ports et leur utilisation, la liste des backslash codes (les \n \t et tous les autres), les codes d'échappement pour coloriser son terminal...

              sinon bah vous méritez qu'on vous lance des petits cailloux, oui. et qu'on vise la tête en plus.
              • [^] # Re: et pourquoi...

                Posté par  . Évalué à 1.

                Je vais vous dire franchement, vous me semblez tous bien conservateurs, bornés et étranges.

                Sur d'autres sites ce projet a reçu un accueil toujours plus chaleureux, ici vous vous bornez à ne pas comprendre l'objectif ni l'utilité du site.
                Si vous ne voulez pas participer, ne participez pas, mais si un jour Polydoc arrive à maturité vous verrez que ce sera super utile.

                "elles sont DEJA documentées... et traduites 36 fois" => Je peux t'assurer que la plupart des bibliothèques que j'ai voulu utiliser, dont j'ai entendu parler ou même qui existent n'ont pas de documentation claire, libre et en français.

                Par contre tous les documents que tu proposes à la traduction (au passage, Polydoc est une documentation, pas un recueil de traductions ou je ne sais quoi) doivent être eux déjà traduits. Par exemple, j'ai lu plusieurs listes de backslash codes en français et accessibles sur Google (dans la moitié des cours de C/C++ y en a une petite liste déjà).
                Bref, pour moi si un document est vraiment indispensable et est reconnu pour l'être, il a du être traduit.

                Quand à la petite blague des petits cailloux, elle est en trop. Nous on essaie de se bouger, de faire des choses pour améliorer le confort de programmation. Tu n'as pas idée de l'investissement que ça représente ni des espoirs que ça suscite.

                Voilà. Je vois pas l'intérêt d'essayer de détruire un projet qui pourrait être utile (je suis pas le seul à le dire), ni celui de casser les gens qui se bougent le cul.
                • [^] # Re: et pourquoi...

                  Posté par  (site web personnel) . Évalué à 3.

                  Si vous ne voulez pas participer, ne participez pas, mais si un jour Polydoc arrive à maturité vous verrez que ce sera super utile.

                  Un peu comme MultideskOS en fait.
                • [^] # Re: et pourquoi...

                  Posté par  . Évalué à 4.

                  à partir du moment où tu demandes l'avis des gens, il faut t'attendre à ce que certains te le donnent. Meme s'il ne te plait pas.

Suivre le flux des commentaires

Note : les commentaires appartiennent à celles et ceux qui les ont postés. Nous n’en sommes pas responsables.