Le fait qu'il existe "une" documentation est déjà étrange. Souvent il y en a plusieurs, avec des objectifs différents.
Le manuel d'utilisation n'est pas la même chose que la référence des APIs ou que la documentation de l'architecture du code.
Selon le type de projet, tous ces documents n'ont pasforcément besoin d'exister. Peut-être qu'il n'y a pas d'utilisateurs (c'est le cas de certains de mes projets exploratoires). Peut-être qu'il n'y a pas d'API ou pas d'architecture.
Mais en général, "va voir dans le code", c'est pénible quand j'essaie d'utiliser le code de quelqu'un d'autre, qu'il n'y a aucune info sur ce que fait chaque fichier et dossier à part son nom, et que c'est écrit dans un langage de programmation que je ne connaìt pas.
[^] # Re: non, c'est l'inverse
Posté par pulkomandy (site web personnel, Mastodon) . En réponse au lien Is Documentation Like Pineapple on Pizza?. Évalué à 7.
Le fait qu'il existe "une" documentation est déjà étrange. Souvent il y en a plusieurs, avec des objectifs différents.
Le manuel d'utilisation n'est pas la même chose que la référence des APIs ou que la documentation de l'architecture du code.
Selon le type de projet, tous ces documents n'ont pasforcément besoin d'exister. Peut-être qu'il n'y a pas d'utilisateurs (c'est le cas de certains de mes projets exploratoires). Peut-être qu'il n'y a pas d'API ou pas d'architecture.
Mais en général, "va voir dans le code", c'est pénible quand j'essaie d'utiliser le code de quelqu'un d'autre, qu'il n'y a aucune info sur ce que fait chaque fichier et dossier à part son nom, et que c'est écrit dans un langage de programmation que je ne connaìt pas.