Je voulais juste rappeler à tous ceux qui produisent des API/frameworks/librairies que rien ne sert de proposer des fonctionnalités formidables s'il est malaisé de les utiliser.
Dans certains cas, on passe tout simplement à côté de fonctionnalités uniquement faute de documentation adéquate. Et il n'y a rien de plus rageant que de s'apercevoir qu'on a du implémenter quelque chose qui était déjà présent, mais non-documenté.
Pour tout ce qui concerne ces catégories de logiciels, je ne peux que renvoyer au modèle du genre qu'est la documentation de PHP. Je crois sincèrement que sa qualité est pour beaucoup dans le succès de ce langage.
Cette documentation est :
- multi-lingue
- collaborative (nombreux commentaires et exemples précieux des utilisateurs)
- exhaustive (précise pour chaque section les versions du langage compatibles)
- abondante
- simple d'accès (php.net/fonction pour un accès direct !)
- rapide
- atomique (chaque section se suffit à elle-même, et ne nécessite pas la lecture d'autres passages)
Bref, c'est du bonheur... L'organisation des thèmes permet facilement de trouver de manière très intuitive des fonctions dont on ne connaissait même pas l'existence !
Alors, je ne citerai personne, mais beaucoup sont concernés ;) Il n'y a pas de honte à reprendre un modèle qui fonctionne... j'espère pouvoir le démontrer prochainement. En attendant, pensez aux utilisateurs néophytes de vos outils, qui ont un réel besoin de documentation performante pour être eux-mêmes performants avec vos API/frameworks/librairies.
Aucun commentaire:
Enregistrer un commentaire