Je dois faire une doc pour du code.. mais pensez vous que je dois reprendre fonction par fonction le code? ou je dois faire une espèce de disseration sur la philosophie du code? C'est vraiment pour expliquer à un noob
merci

Quel langage ? Il y a certains outils qui peuvent t'être utiles afin de générer automatiquement une documentation en fonction des annotations placées avant tes méthodes, etc.

Ca c'est déjà fait dans le code, mais c'est vraiment une documentation pour expliquer le code à des noob.

Expliquer chaque function fichier par fichier te semble un bon pattern?
C'est du solidity

Peut-être en en faisant un organigramme sur papier dans lequel on voit les fonctionnalités et leurs interactions.
Avec de la couleur c'est plus joli.
Tu pourrais déjà poster quelque chose sur laquelle on pourrait travailler
Qu'est-ce qu'il fait ton code ?

Le 25 juin 2020 à 10:30:17 ouimaisquoi a écrit :
Peut-être en en faisant un organigramme sur papier dans lequel on voit les fonctionnalités et leurs interactions.
Avec de la couleur c'est plus joli.
Tu pourrais déjà poster quelque chose sur laquelle on pourrait travailler
Qu'est-ce qu'il fait ton code ?

Il y’a plusieurs composants, mais c’est good j’ai vu avec mon collègue, je dois expliquer tout ce qui n’est pas forcément trivial

Le 25 juin 2020 à 10:59:50 laleonidas a écrit :

Le 25 juin 2020 à 10:30:17 ouimaisquoi a écrit :
Peut-être en en faisant un organigramme sur papier dans lequel on voit les fonctionnalités et leurs interactions.
Avec de la couleur c'est plus joli.
Tu pourrais déjà poster quelque chose sur laquelle on pourrait travailler
Qu'est-ce qu'il fait ton code ?

Il y’a plusieurs composants, mais c’est good j’ai vu avec mon collègue, je dois expliquer tout ce qui n’est pas forcément trivial

+1 pour le schéma le visuel c’est important

Le 25 juin 2020 à 10:59:50 laleonidas a écrit :

Le 25 juin 2020 à 10:30:17 ouimaisquoi a écrit :
Peut-être en en faisant un organigramme sur papier dans lequel on voit les fonctionnalités et leurs interactions.
Avec de la couleur c'est plus joli.
Tu pourrais déjà poster quelque chose sur laquelle on pourrait travailler
Qu'est-ce qu'il fait ton code ?

Il y’a plusieurs composants, mais c’est good j’ai vu avec mon collègue, je dois expliquer tout ce qui n’est pas forcément trivial

Bon, ben on saura pas ce qu'il fait ton code, c'est pas grave si on s'en fout.

Quand on parle de documentation, il est en general bon de preciser l'audience. Est ce de la documentation pour l'utilisateur finale du logiciel? pour l'admin systeme qui doit installer le logiciel? pour un mainteneur du logiciel? Pour un auteur de plugin? La documentation pour ces differents groupes est typiquement tres differente.

J'imagine que c'est pour un mainteneur du code. En general, cette personne a besoin d'une vue globale du logiciel, des differents composant et de quel composant est responsable pour quoi. Apres toute la documentation est dans le code.

Le 25 juin 2020 à 19:46:33 godrik a écrit :
Quand on parle de documentation, il est en general bon de preciser l'audience. Est ce de la documentation pour l'utilisateur finale du logiciel? pour l'admin systeme qui doit installer le logiciel? pour un mainteneur du logiciel? Pour un auteur de plugin? La documentation pour ces differents groupes est typiquement tres differente.

J'imagine que c'est pour un mainteneur du code. En general, cette personne a besoin d'une vue globale du logiciel, des differents composant et de quel composant est responsable pour quoi. Apres toute la documentation est dans le code.

Merci pour la réponse. Je suis parti sur une vue globale + explications pour chaque composant