Jump to content

Documentation technique : existe-t-elle ?


Recommended Posts

Bonjour à tous,

 

Je dois réaliser des modifications de modules sur un site de type Prestashop et je suis à la recherche d'une documentation détaillant chaque classe et méthode du core de Prestashop (je cherche par exemple s'il existe une méthode de la classe Category qui renvoie uniquement la liste des classes visibles par l'utilisateur courant).

 

Est-ce qu'un tel document existe à l'instar du codex Wordpress par exemple ?

 

Merci d'avance pour votre aide précieuse.

Link to comment
Share on other sites

  • 1 month later...

Je remonte ce topic pour avoir quelques nouvelles.

 

Est-ce que vous envisagez de faire une documentation pour développeur comme le fait wordpress avec sont codex, je parle d'un vrai détails des classes/méthodes et de leurs utilités, déprécié ou non et à partir de qu'elle version etc...

 

Je sais que c'est un travail de titan de faire une tel doc mais faut bien commencer un jours sinon elle ne verras jamais le jours et j'ose même imaginer que vous avez déjà une tel documentation en interne pour les nouveaux développeurs qui arrivent chez vous sinon je les plaint les pauvres.

 

Plus sérieusement est-ce que c'est dans vos projets de faire une vrai doc digne de ce nom ou pas du tout?

 

merci

  • Like 1
Link to comment
Share on other sites

  • 1 year later...

+1 j'ai bien la doc PDF v1 http://www.prestashop.com/download/Techguide_fr.pdf mais qui date de 2010 ainsi que http://doc.prestashop.com/dashboard.action mais incomplète ou alors il faut maîtriser la langue de shakespeare ! J'ai acheter la doc utilisateur, sympa il faudrait la même pour les intégrateur et développeur... Les formations ? Oui j'en ai déjà faite et j'ai aussi celle de tuto.com mais on oublie vite certaine partie et un support papier est très pratique quand on est sur le terrain et qu'on à pas d'internet ^^ Et les livres je n'ai rien trouvé d'intéressant sur le marché, uniquement pour les débutants... Bref il y a je trouve un vide de ce coté là... On aimerais pouvoir approfondir certains domaines...

Link to comment
Share on other sites

La doc 1.5 FR est mise à jour petit à petit. La EN est certe plus compléte pour le moment, mais bon qui aime rédiger de doc ? :D

 

A l'excellente initiative du captain Flam tu peux trouver ici l'api de Prestashop sous Doxygen... Enfin bon le problème c'est que ça dépends des commentaires phpDoc... Et faut dire que parfois c'est pas leur points fort... Un jour peut-être il mettront en place un vrai système d'api.

 

La meilleur solution est de rentrer dans la communauté, et à l'ancienne : prendre du plaisir à parcourir du code spaghetti o/

Link to comment
Share on other sites

La doc 1.5 FR est mise à jour petit à petit. La EN est certe plus compléte pour le moment, mais bon qui aime rédiger de doc ? :D

 

A l'excellente initiative du captain Flam tu peux trouver ici l'api de Prestashop sous Doxygen... Enfin bon le problème c'est que ça dépends des commentaires phpDoc... Et faut dire que parfois c'est pas leur points fort... Un jour peut-être il mettront en place un vrai système d'api.

 

La meilleur solution est de rentrer dans la communauté, et à l'ancienne : prendre du plaisir à parcourir du code spaghetti o/

 

Entièrement d'accord. Maintenant, quand on veux aller un peu plus loin et ne pas s'arrêter à ce qu'on connait ou ce que l'on a vu dans un bout de code fonctionnel (l'idée étant évidemment que tout développement soit fonctionnel) mais non optimisé ou encore en utilisant des techniques invraisemblables (et je le dis car PrestaShop est une mixité de code fonctionnel mais complètement différent selon le moment de la production de celui-ci...) c'est assez délicat de pouvoir farfouiller là-dedans.

 

La démarche réalisée par CaptainFlam est intéressante. Malheureusement, les mises à jour se font et le suivi de ce genre de document n'est pas possible et il serait d'ailleurs intenable de l'utiliser. La simple et bonne raison que PrestaShop n'utilise pas (bien que ce sont les normes de développement) les blocs de commentaires phpDoc comme il se devrait et qui plus est que l'on a des nouvelles méthodes au fur et à mesure. Fut un temps, j'avais une documentation de ce genre alimentée au fur et à mesure des versions des méthodes existantes. Ce qui permettait également de pouvoir cibler une version spécifique de PrestaShop et d'en connaître les méthodes disponibles (et ainsi pouvoir définir si l'on devait ou non utiliser une ou l'autre méthode en fonction de son projet). L'analyseur de classes/controllers est toujours actif, je devrais voir éventuellement pour le faire tourner à nouveau et imaginer une nouvelle interface de documentation technique (mais pas de documentations d'utilisations, malheureusement !).

 

+1 j'ai bien la doc PDF v1 http://www.prestasho...echguide_fr.pdf mais qui date de 2010 ainsi que http://doc.prestasho...ashboard.action mais incomplète ou alors il faut maîtriser la langue de shakespeare ! J'ai acheter la doc utilisateur, sympa il faudrait la même pour les intégrateur et développeur... Les formations ? Oui j'en ai déjà faite et j'ai aussi celle de tuto.com mais on oublie vite certaine partie et un support papier est très pratique quand on est sur le terrain et qu'on à pas d'internet ^^ Et les livres je n'ai rien trouvé d'intéressant sur le marché, uniquement pour les débutants... Bref il y a je trouve un vide de ce coté là... On aimerais pouvoir approfondir certains domaines...

 

Nous sommes d'accord, la documentation technique de PrestaShop 1.5 est pauvre et, qui plus est, parfois inadéquate. Effectivement, des bribes de l'ancienne version sont parfois insérées dans la nouvelle. Ce qui n'est pas des plus pratiques, il faut en convenir. Fut un temps (bien que je le fasse encore rarement), j'éditais cette documentation en collaboration avec PrestaShop et plus précisément Xavier, le responsable documentation. L'ennui, c'est que la documentation doit aussi couvrir la documentation utilisateur, administrateur et j'en passe et est gérée exclusivement par Xavier. Ce qui ne lui permet pas de couvrir l'ensemble des points de façons complètes et qui plus est rapidement. Malheureusement.

 

Concernant les tutoriels, ils en existent quelques uns mais j'accorde qu'ils sont parfois fort ciblés ou encore non adaptés à un certain niveau de complexité ou de connaissances (me concernant, chaque tutoriel m'apporte quasiment toujours une nuance inconnue de la manière de procéder quant à la mise en oeuvre d'un développement ou encore par la code adapté).

 

Les livres, parlons-en ! Il en existe, on l'accorde. Très peu. Je pense pouvoir dire qu'ils se compte sur les doigts de deux mains maximums (pour ne pas être trop restrictifs, tout de même). Mais, surtout, quasiment aucun n'est destiné à de la documentation technique ou plus précisément à des développeurs désireux d'en apprendre d'avantages sur PrestaShop et le développement de boutique avec ce dernier.

 

Cependant, j'ai tout de même le plaisir de pouvoir dire que - du moins je l'espère ! - ce genre de discours changerait petit à petit dans quelques mois. Effectivement, je suis actuellement plongé dans la rédaction d'un ouvrage technique entièrement destiné aux développeurs PrestaShop. Le contenu de cet ouvrage sera aussi bien destinés aux débutants (prise en main basique) qu'aux plus expérimentés sur la solution. Avec des explications, des exemples techniques et des référentiels de fonctions.

 

Et, pour finir, je peux même dire que cet ouvrage amène non seulement un côté physique non négligeable de documentation mais qu'au fur et à mesure de l'écriture et de ma lecture de codes (vous n'imaginez pas combien de temps j'ai pu passé à la lecture de code !), j'ai moi-même découvert des fonctionnements jusque là inconnus... Fonctionnement que je ne manques donc pas de transcrire, tant qu'à faire ! ;-)

Edited by J. Danse (see edit history)
  • 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...