C'est bien connu, il est bien plus pratique d'avoir de la doc écrite par un mec qui n'est pas à l'origine du bout de code qui a été rajouté.
Oui, complètement.
Et ça ne vaut pas que pour le code.
Un mec qui code bien n'est toujours quelqu'un doué pour écrire de la doc. (Si on était vrendredi, j'aurais même rajouté que c'est même plutôt rare).
D'autant plus que quelqu'un qui est à l'origine du truc considère beaucoup de trucs comme acquis, ou évident, ou simplement oublie de parler d'un truc.
Alors que quand un mec s'est fait chier pour comprendre quelque chose, il a déjà fait le parcourt intellectuel pour essayer de comprendre le truc. Donc il sait ce qu'il faut documenter, les choses à prendre en compte, là où il faut insister, les trucs qu'il faut éviter ou ce dont il faut se méfier, les éventuels prérequis qu'il n'avait pas avant etc.
Alors certes, ça demande plus d'effort, mais ça fait une documentation bien plus accessible par la suite.
[^] # Re: En tant que BSDiste je me permets de participer au troll
Posté par j_kerviel . En réponse au journal Linux ou POSIX ?. Évalué à 9.
C'est bien connu, il est bien plus pratique d'avoir de la doc écrite par un mec qui n'est pas à l'origine du bout de code qui a été rajouté.Oui, complètement.
Et ça ne vaut pas que pour le code.
Un mec qui code bien n'est toujours quelqu'un doué pour écrire de la doc. (Si on était vrendredi, j'aurais même rajouté que c'est même plutôt rare).
D'autant plus que quelqu'un qui est à l'origine du truc considère beaucoup de trucs comme acquis, ou évident, ou simplement oublie de parler d'un truc.
Alors que quand un mec s'est fait chier pour comprendre quelque chose, il a déjà fait le parcourt intellectuel pour essayer de comprendre le truc. Donc il sait ce qu'il faut documenter, les choses à prendre en compte, là où il faut insister, les trucs qu'il faut éviter ou ce dont il faut se méfier, les éventuels prérequis qu'il n'avait pas avant etc.
Alors certes, ça demande plus d'effort, mais ça fait une documentation bien plus accessible par la suite.