Pour le peu que j'ai eu à travailler avec la doc MSDN, en c++ pour l'anecdote, je me suis retrouvé avec une doc assez complète à l'index assz douteux, il faut le reconnaitre, mais surtout écrite par un ingénieur surement hyper fort mais incapable de vulgariser. La doc MSDN est en générable imbitable. C'est son plus grand défaut.
La doc Java, bien que mieux structurée, est à peine mieux, on doit quelque fois tirer le vers du nez à google....
Non, la meilleur doc que j'ai jamais rencontré et distançant toutes les autres, et de très loin est, je vais me faire tapper dessus, celle de Windev.
EH oui ça peut paraître étonnant, mais cette environnement de dev ultra-propriétaire et très bugué est doté d'une doc quasi parfaite, complète et limpide.
Par exemple quand on cherche les fonctions opérant sur chaîne, on tombe déjà sur un tableau avec le nom de la fonction, et ce qu'elle fait. C'est betement stupide, mais j'ai rarement vu ça ailleurs.
Ensuite, lorsque l'on va voir la fonction en détaille, on a :
- un exemple en situation
- une description de la fonction
- le détail de tous les paramètres, chacun expliqué
- des remarques éventuelles.
- un lien "voir aussi", très intelligent qui permet de naviguer et souvent de trouver ce qu'on cherche.
C'est très bien pensé, parce qu'en caricaturant, ya deux types de gens : les inductifs et les déductifs; Les premiers comprennent avec un exemple, les seconds avec une explication formelle.
Les docs logiciels sont beaucoup trop arides à mon goût, et ça fait fuir pas mal de gens à mon avis.
Je pense que les langages dont les libs sont bien documentés auront un net avantage sur les autres.
En fait il faut pour un langage, deux types de doc pour une même lib :
- une doc aride qui reprend toutes les autres, du style http://smarteiffel.loria.fr/libraries/index.html
- une doc style windev comme décrite plus haut, pour les principales libs les plus utilisés.
De la sorte, le débutant commence avec la seconde, se fait la main, et ne reste pas bloqué des heures, et le dev expérimenté dispose d'une doc complète qui lui suffit.
Une base de connaissance bien structurée en plus et c'est parfait.
« Il n’y a pas de choix démocratiques contre les Traités européens » - Jean-Claude Junker
[^] # Re: et moi j'ai vu la Vierge
Posté par Ontologia (site web personnel) . En réponse au journal Des vertus pragmatico-économiques de la monoculture Microsoft. Évalué à 5.
La doc Java, bien que mieux structurée, est à peine mieux, on doit quelque fois tirer le vers du nez à google....
Non, la meilleur doc que j'ai jamais rencontré et distançant toutes les autres, et de très loin est, je vais me faire tapper dessus, celle de Windev.
EH oui ça peut paraître étonnant, mais cette environnement de dev ultra-propriétaire et très bugué est doté d'une doc quasi parfaite, complète et limpide.
Par exemple quand on cherche les fonctions opérant sur chaîne, on tombe déjà sur un tableau avec le nom de la fonction, et ce qu'elle fait. C'est betement stupide, mais j'ai rarement vu ça ailleurs.
Ensuite, lorsque l'on va voir la fonction en détaille, on a :
- un exemple en situation
- une description de la fonction
- le détail de tous les paramètres, chacun expliqué
- des remarques éventuelles.
- un lien "voir aussi", très intelligent qui permet de naviguer et souvent de trouver ce qu'on cherche.
C'est très bien pensé, parce qu'en caricaturant, ya deux types de gens : les inductifs et les déductifs; Les premiers comprennent avec un exemple, les seconds avec une explication formelle.
Les docs logiciels sont beaucoup trop arides à mon goût, et ça fait fuir pas mal de gens à mon avis.
Je pense que les langages dont les libs sont bien documentés auront un net avantage sur les autres.
En fait il faut pour un langage, deux types de doc pour une même lib :
- une doc aride qui reprend toutes les autres, du style http://smarteiffel.loria.fr/libraries/index.html
- une doc style windev comme décrite plus haut, pour les principales libs les plus utilisés.
De la sorte, le débutant commence avec la seconde, se fait la main, et ne reste pas bloqué des heures, et le dev expérimenté dispose d'une doc complète qui lui suffit.
Une base de connaissance bien structurée en plus et c'est parfait.
« Il n’y a pas de choix démocratiques contre les Traités européens » - Jean-Claude Junker