Hors série - 13 points que les gens détestent sur la documentation de certains logiciels libres

Qu’il s’agisse de son code ou de son utilisation, la faiblesse de la documentation d’un logiciel libre est souvent montrée du doigt. Voici, selon Andy Lester, 13 lacunes communément rencontrés dans la documentation accompagnant certains logiciels libres. Ce constat a été publié sur le site Web SmartBear :

1. Le manque d’une bonne introduction ou d’un README/LISEZ-MOI

2. La documentation non disponible en ligne

3. La documentation disponible uniquement en ligne

4. La documentation non installée avec le logiciel

5. Le manque de captures d’écran

6. Le manque d’exemples réalistes

7. Des liens et références inadéquats

8. Oublier les nouveaux utilisateurs

9. Ne pas écouter les utilisateurs

10. Ne pas accepter les suggestions des utilisateurs

11. Impossibilité de voir ce que fait le logiciel sans l’installer

12. S’appuyer sur la technologie pour la rédaction de la documentation

13. L’arrogance et l’hostilité vis-à-vis de l’utilisateur

En contrepartie, dans un second texte intitulé 14 Ways to Contribute to Open Source without Being a Programming Genius or a Rock Star publié sur le même site Web l’auteur fait un certain nombre de recommandations afin de redresser la situation.

 

Michel Roberge