Jump to content

La documentation c'est pour quand ?


Recommended Posts

Ce message s'adresse avant tout à l'équipe.

 

Quand disposera t on d'une documentation correcte ? La version actuelle est affreusement vide et les rares informations qu'elle donne sont de très peu d'intérêt...

 

Aujourd'hui nous perdons un temps fou à chercher ce qui aurait du être documenté au fur et a mesure que le code avançait ! Bien sur je ne parle pas de doc utilisateur (ce qui a tres peu d’intérêt, a par pour un logique commerciale a court terme incitant les newbies a pencher pour presta), mais d'une vraie doc dev... que faire sans ?

Ca fait 3 ans que j'utilise prestashop mais la je suis au bord ! De versions en versions vous répétez les mêmes erreurs sans vous lasser. Que présager pour le futur ?

 

Si vous ne vous décidez pas à faire une vraie doc, laissez au moins la possibilité à la communauté de le faire en ouvrant un wiki... M'est avis - et pas qu'à moi - que le modèle pseudo open source choisi pas votre société n'est pas un modèle d'avenir : quand on se veut open source, on laisse la communauté agir... j'ai déjà proposé des patchs sur la forge, qui ont été commit tels quel, sauf que l'auteur était un membre de la prestateam - ne pas rendre crédit n'est pas une bonne manière d'encourager la communauté à faire quoi que ce soit !!!

 

De plus nous n'avons accès à aucun choix technique et nous retrouvons parfois obligés de subir des choix aberrants, choix qui n'auraient probablement pas été fait si vous aviez consulté la communauté. Nous ne pouvons pas proposer de vision du code, et la contribution bénévole n'est pas encouragée : il n'y a qu'à voir comment sont mis en avant les modules payant, et comme aucune plateforme correcte n'existe pour les modules gratuits ! Mais mince, regardez un peu autour de vous, il n'y a aucune communauté de dev sur prestashop, ca vous fait pas vous poser des questions ? Sur drupal la moindre virgule est documenté et chaque problématique de dev pouvant être rencontrée à au moins été traitée 10 fois, ce qui est on ne peut plus encourageant pour des dev, pour leur montrer qu'une vraie communauté existe et qu'ils ne se retrouveront pas seuls, comme ils le sont actuellement sur prestashop - solution dont la visée monétaire avant tout ne fait tellement aucun doute que tout y est payant même les modules les plus ridicules !

 

Il est temps de faire un choix, si vous ne voulez pas voir le nombre de dev serieux bossant sur cette solution diminuer drastiquement...

 

(Mais rassurez vous il restera toutes ces agences profiteuses qui facturent a fond pour installer presta et 2 3 modules à des debutants dans l'ecommerce qui s'appercevront bien vite des limitations... mais j'ai comme l'impression que c'est un business model assumé ! Beaucoup font leur beurre la dessus, mais au bout d'un moment les gens vont s'en appercevoir !)

 

Bien a vous,

un dev qui aimait presta pour les possibilités d'avenir que cette solution laissait entrevoir

et que les dernières versions ont bien déprimé

  • Like 3
Link to comment
Share on other sites

et il reste tellement d'autres sujet déprimants à aborder... les anti pattern sont tellement nombreux dans le code que je ne sais pas par ou commencer !! Peut être devriez vous trouver un moyen d’écouter votre communauté ?

  • Like 1
Link to comment
Share on other sites

J'ai cru pendant 7 secondes que tu parlais de la doc utilisateur, sur laquelle je m’échine depuis un bon moment :)

J'ose par ailleurs affirmer que cette doc utilisateur est non seulement utile, mais essentielle -- nombre d'utilisateur ne sont pas au niveau des développeurs, pour qui utiliser une interface correctement revient à faire appel à des habitudes intégrées.

 

Mais bref, la doc dev. Crois-le ou non, mais il s'agit de mon prochain projet. Comme on peut le voir dans la doc 1.5 anglaise, il y a déjà quelques pages. Seulement, celles-ci varient largement en contenu. Mon but est de reprendre le tout pour en faire quelque chose de cohérent et utile (à défaut d'être exhaustif, du moins dans un premier temps).

 

Bien entendu je n'y arriverai pas seul, devant moi-même faire appel à mon bon sens comme aux informations données par les développeurs. De fait, je suis plus que jamais preneur d'avis et d'idées de la part de la communauté. Si vous vous sentez d'écrire sur un sujet (même uniquement le côté technique/code, je peux me charger de l’enjolivement textuel), n'hésitez pas à me contacter directement, et pourra faire progresser cette partie !

 

Bref, discutons ! Je suis ouvert à toutes les propositions, mon objectif avec les documentation étant d'être aussi utile que possible pour les utilisateurs.

  • Like 2
Link to comment
Share on other sites

suggestion déjà formulée : en faire un wiki, dont tu devras être le contributeur principal.

deuxième suggestion : un doxygen officiel

troisième suggestion : faire des vrais rapports de mise à jour ( pas juste une copie du log svn)

 

dans le wiki les points urgents à traiter sont : les helpers. on est pas censés deviner comment ca marche !!; revoir la doc module, les controlleurs, les surcharges, les classes principales, le cache ( et plein d'autres choses )

 

Hors de question pour moi d'être le nègre (littéraire) de prestashop : ma contribution sera ne sera possible que via un wiki, ou par demande spécifique duement créditée et financée.

je trouve d'ailleurs cette attitude assez typique de prestashop... si vous voulez nous aider, ok, mais en privé et gratuitement. Et on dira que c'est nous qui l'avons fait ! Pas très "open source"...

 

 

Pour la doc utilisauteur, je persiste et signe : le public ciblé par elle est bien moins crucial à la survie à long terme de la solution. Faire croire a des gens non dev qu'ils peuvent monter leur site de vente en ligne est à mon avis manipulateur et tue le business. Y a des professionnels pour ça, et ils devraient être votre coeur de cible !!

Edited by BigZ (see edit history)
  • Like 1
Link to comment
Share on other sites

Pour la doc utilisauteur, je persiste et signe : le public ciblé par elle est bien moins crucial à la survie à long terme de la solution. Faire croire a des gens non dev qu'ils peuvent monter leur site de vente en ligne est à mon avis manipulateur et tue le business. Y a des professionnels pour ça, et ils devraient être votre coeur de cible !!

 

Je suis moins d'accord sur ce coup là...

 

Le succès de Prestashop est en partie du aux ecommerçants ciblés par cette doc. Et il faut, à mon avis, continuer à attirer les ecommerçants avec ce genre de prestation que de laisser croire que le ecommerce est réservé à une catégorie de personne etc..

 

V++

 

Atch

Link to comment
Share on other sites

En tant que développeur je suis totalement d'accord avec BigZ et je comprend ce coup de geule, on perd un temps fou à comprendre le fonctionnement de prestashop car il n'y a aucune doc technique viable.

 

Une écoute plus attentive de la communauté de développeur ne serait pas de trop !

Link to comment
Share on other sites

Un coup de gueule de la communauté ? OK !

Mais dans ce cas la, pourquoi ne pas aider Xavier sur la doc ?

 

Je ne pense pas que Mon chère amis Xavier ai le temps de gérer un Wiki pour le moment alors que la doc n'est pas encore totalement traduite...

 

Je ne sais pas moi, au lieu de pousser des coup de gueule à tord et à travers, ne pourriez vous pas tous simplement l'aider ?

 

Certain le fond au travers de ce forum, envoyer lui tous simplement la doc, et il se chargera du reste : traduction, mise en forme, fautes d'orthographes, ...

 

Bien à vous,

Loic

Link to comment
Share on other sites

Il y a une différence entre contribuer à la communauté et travailler gracieusement pour prestashop. Moi je veux bien participer à la doc développeur mais il faudrait déjà que prestashop ouvre son wiki à la communauté.

 

Comme le dit si bien une célèbre marque de biscuit : Ouvrons le champs des possibles !

Link to comment
Share on other sites

merci paco... c'est un appel à ouvrir prestashop vers sa communauté, pas une demande de stage non rémunérée !

encore une fois : je veux bien aider une communauté, pas une entreprise. Oui, xavier, tu serais bien plus utile en modo de wiki qu'en traducteur !

Le publoc dev se sent vraiment lésé avec cette attitude : nous, on veut pas de traduction (tous les dev parlent anglais) ni d'un nouveau tuto mal foutu ! on veut un wiki pour la doc, un site de module communautaire, et avant tout ! pouvoir contribuer de notre avis au dev futurs de prestashop... que le modele ne soit pas que discuté qu'en interne, mais au moins expliqué à la communauté, au mieux disucté avec elle

encore mieux... pouvoir proposer nos propres patchs sur votre gestionnaire de version !

  • Like 1
Link to comment
Share on other sites

Ya quelqu'un de prestashop pour nous répondre ? Qui donc se charge de la gestion de projet ?

Qui donc prend ces décisions ? Ce projet se revendique communautaire, hors il n'en est rien ! La communauté n'a absolument aucun rôle dans le développement de la solution et se contente de fournir de la main d'oeuvre bénévole pour en assurer le support...

Pour notre bien, pour le bien de la solution à long terme, il est crucial que vous l'ouvriez à ceux qui ont une vision claire de la solution et de ses problèmes : les développeurs qui l'utilisent quotidiennement !

 

Je suis prestashop depuis le début (j’étais en cours avec et connait bien personnellement certains des fondateurs), et j'avais bon espoir qu'il devienne un jour un grand du cms : aujourd'hui mes espoirs sont quasiment réduits à néant.... Vous avez fais de nombreux choix dans une optique commerciale à court terme et ça risque de vous coûter cher à long terme !

 

La majorité des systèmes open source viables ne basent pas leur revenus sur du freemium mais sur de la vente de service... le logiciel devrait être gratuit; et les professionnels se charger de créer des ensembles cohérents, de faire du conseil, de personnaliser pour les commerçants qui si ils ne sont pas développeur devraient en payer un et ne pas croire au mirage du "c'est super facile pas besoin d'y connaitre quelque chose", publicité mensongère extrêmement négative pour le milieu et ses professionnels à long terme.

 

Au secours !

Link to comment
Share on other sites

Salut,

 

@BigZ > AMHA, ça ne sert strictement à rien de documenter le code. D'une part, personnellement j'ai consulté le "Guide du développeur" une ou deux fois au début, ensuite j'ai tout simplement lu le code pour comprendre ce qu'il fait.

 

Franchement, en tant que dev, tu vas pas pleurer pour une doc quoi ?

Ok, c'est pas sérieux de la part de PrestaShop de ne pas fournir de doc, mais ça empêche pas de mettre les mains dans le cambouis. PrestaShop ça envoie pas des fusées sur la lune, ya pas besoin d'être un génie pour comprendre comment ça marche..

 

 

De plus, à quoi bon documenter un méthode de 400 lignes qui a 20 paramètres et fait 10 trucs en même temps ? :)

Link to comment
Share on other sites

suggestion déjà formulée : en faire un wiki, dont tu devras être le contributeur principal.

 

L'outil derrière doc.ps.com est Confluence, qui fonctionne comme un wiki (en cela que vous pouvez d'ores et déjà faire des diff entre les versions des pages). J'ai depuis longtemps la volonté d'ouvrir son édition aux membres de la communauté, mais dans les faits, la base utilisateur de cette installation de Confluence et celle de la Forge ne sont pas les mêmes, et donc l'inscription ne peut pas être automatique.

 

Je peux créer des comptes doc.ps.com à la main. C'est contraignant, mais il n'est donc pas impossible de participer à l'évolution de la doc...

 

deuxième suggestion : un doxygen officiel

 

Oui, je suis sur le coup (a priori plutôt un phpDoc).

 

troisième suggestion : faire des vrais rapports de mise à jour ( pas juste une copie du log svn)

 

Ca, ce n'est pas de mon ressort :)

 

dans le wiki les points urgents à traiter sont :

  • les helpers. on est pas censés deviner comment ca marche !!;
  • revoir la doc module,
  • les controlleurs,
  • les surcharges,
  • les classes principales,
  • le cache
  • (et plein d'autres choses )

 

Oui, donc tout, c'est bien ce pourquoi je vais d'abord faire un dump de toutes les infos techniques que je peux recolter en interne, et ensuite mettre à jour/en forme :)

 

Hors de question pour moi d'être le nègre (littéraire) de prestashop : ma contribution sera ne sera possible que via un wiki, ou par demande spécifique duement créditée et financée.

 

Soit ! Tu veux quel username ? :)

 

je trouve d'ailleurs cette attitude assez typique de prestashop... si vous voulez nous aider, ok, mais en privé et gratuitement. Et on dira que c'est nous qui l'avons fait ! Pas très "open source"...

 

Et tu auras donc compris je l'espère que ce n'est pas du tout l'idée, juste une envie de bien faire (une seule base utilisateur) qui amène une contrainte technique, hélas non résolue encore. il faut donc la contourner. Ce sera moins idéal, mais au moins la doc gagnera-t-elle en ouverture.

  • Like 1
Link to comment
Share on other sites

Create an account or sign in to comment

You need to be a member in order to leave a comment

Create an account

Sign up for a new account in our community. It's easy!

Register a new account

Sign in

Already have an account? Sign in here.

Sign In Now
×
×
  • Create New...