Il manque à mon avis le truc basique qu'on trouve rarement : commencer par expliquer le concept.
Il y a un paquet de documentations qui ne prennent même pas la peine d'expliquer à quoi sert le produit/service/API/etc. Et qui ne prennent même pas la peine de décrire le fonctionnement général, le principe.
On retrouve la même chose sur plein de sites web pour des logiciels (libres ou non). Il y a des news, des forums, un lien de téléchargement, tout ce qu'on veut… mais on ne sait pas à quoi sert le truc. Est-ce un logiciel "lourd", une bibliothèque, un élément utile uniquement en relation avec une autre chose bien précise ?
# La base de la base
Posté par Kerro . En réponse au journal Jacob Kaplan-Moss: Écrire une bonne documentation. Évalué à 10.
Il manque à mon avis le truc basique qu'on trouve rarement : commencer par expliquer le concept.
Il y a un paquet de documentations qui ne prennent même pas la peine d'expliquer à quoi sert le produit/service/API/etc. Et qui ne prennent même pas la peine de décrire le fonctionnement général, le principe.
On retrouve la même chose sur plein de sites web pour des logiciels (libres ou non). Il y a des news, des forums, un lien de téléchargement, tout ce qu'on veut… mais on ne sait pas à quoi sert le truc. Est-ce un logiciel "lourd", une bibliothèque, un élément utile uniquement en relation avec une autre chose bien précise ?