Articles précédents : Articles
- [161] Sun et le logiciel libre : deux nouveaux épisodes du feuilleton de l'été
- [291] (petits) changements du système de notation
- [84] Brevets Logiciels, dernière action, dernière chance !
- [29] Livre sur GIMP 2 en cours de réalisation
- [83] Modules non GPL et tours de passe-passe
- [38] ObjectWeb et Eclipse WebTools
- [123] Mozilla et Gnome, main dans la main ?
- [43] Distribution Gentoo : des nouvelles du front
- [31] SSTIC, les vidéos en ligne
- [479] La sortie de la prochaine Debian menacée ?
Liens connexes
- HOWTO: write bad documentation that looks good (561 hits)
- Fundamental issues with open source software development (266 hits)
- The State of OSS Documentation (311 hits)
Dépêche modérée par
Articles : Documentation et projets libres commerciaux : sondage
Posté par Telleum (page perso, ). Modéré le 05 mai 2004.
![[en]](../../../images/en.png)
HOWTO: write bad documentation that looks good (561 hits)-
Fundamental issues with open source software development (266 hits)
-
The State of OSS Documentation (311 hits)
> Lire la suite (9 commentaires, moyenne: 3). [dépêche : 755 caractères]
Il serait intéressant de connaître l'expérience personnelle de chacun et la politique adoptée par les SSLL et autres sociétés commerciales qui développent des logiciels libres.
Réponse
- Mon opinion, pas forcément en rapport avec le libre, est qu'un "logiciel" très bien documenté sera plus utilisé et plus populaire qu'une killerapp mal documentée.
Et que je dis logiciel, ca peut etre un soft (du point de vue end-user) ou une API (du point de vue développeur). Moi le premier, je préfère avoir un truc plus lent et bien documenté, qu'une merveille nécessitant de découvrir à la main toutes les fonctionalités.
Dans le domaine scientifique, FEMLAB est une réussite. Et bien ce n'est pas du tout du tout le meilleur code que j'ai vu. Par contre c'est souple, bien concu, bien documenté. Ca aide BEAUCOUP. Tout le monde n'a pas envie de passer ses journées à découvrir des fonctionnalités "cachées".
- Je travaille sur un projet universitaire basé (quasiment uniquement) sur de la documentation d'algos existant.
- Dans mon entreprise c'est une priorité officielle la doc, et on arrive quand même des fois à se retrouver avec des libs pas documentés, ou alors avec des version archaiques.
-
[^]Documentation et succès d'un logiciel
Posté par Encolpe DEGOUTE (page perso, ) le 06/05/2004 à 07:38. (lien). Évalué à 4.Dans le cas d'un logiciel commerciale libre la documentation est primordiale s'il existe déjà d'autre projets sur le même segment de marché.
Lorsqu'un utilisateur teste un logiciel avant d'en acheter le service de personnalisation, si la documentation est pauvre ou uniquement commerciale il sera rapidement frustré de ne pas pouvoir reproduire ce qu'il a vu quand on lui a présenté de logiciel. Au bout de deux ou trois jours de galère il dira que le logiciel est sympa, très puissant, mais inutilisable tel que.
J'ai vu des boîtes perdre des contrats là-dessus, et d'autres en gagner.
Par contre une mauvaise documentation des API (ou une documentation générée automatiquement), sans tutorial digne de ce nom, sans manuel pour le dévellopeur et l'administrateur ne donnera aucun engouement dans le projet pour les dévellopeurs éventuels. Donc une communauté quasiment nulle. Les documentations en retard de trois versions, ou uniquement dans la langue de Molière ou de Shakespeare ne sont pas pour aider non plus.
-
[^]Re: Réponse
Posté par calandoa () le 06/05/2004 à 09:09. (lien). Évalué à 4.Ca peut etre un soft (du point de vue end-user) ou une API (du point de vue développeur)
C'est tout à fait vrai pour une API, mais ça l'est à mon avis beaucoup moins pour une application pour laquelle la plupart des utilisateurs ne liront jamais la doc et se contenteront d'utiliser les fonctionnalités qu'ils ont comprises intuitivement... et le problème en général avec la doc des applications, c'est que sont documentées que les fonctionnalités que l'on peut comprendre tout seul, c'est-à-dire, par exemple, qu'on va avoir un bon gros paragraphe sur le menu "edit" pour nous dire que "copier" correspond à "placer le texte sélectionné de la fenètre d'édition dans le presse papier", mais dans le menu "tool", l'entrée "conversion" sera documenté comme "effectue la conversion" sans savoir quelle source, quelle destination, quels formats etc... Le pire des exemples de ce genre est l'aide de windows dont le texte est complétement redondant par rapport à l'interface...
Sinon, dans un aute domaine,, aucun des 3 liens ne parlent des différentes licences utilisables pour une doc... quelqu'un a plus d'infos dessus, ou une doc?-
[^]Re: Réponse - Licences doc
Posté par Telleum (page perso, ) le 06/05/2004 à 12:59. (lien). Évalué à 3.> Sinon, dans un aute domaine,, aucun des 3 liens ne parlent des différentes licences utilisables pour une doc... quelqu'un a plus d'infos dessus, ou une doc? Si l'on ne spécifie pas de licence, le document est soumis a priori aux règles du droit d'auteur tel que défini par le code de la propriété intellectuelle. Bref c'est plutôt fermé. Il existe ensuite plusieurs licences applicables aux documentations pour les logiciels libres:
- GPL: eh oui ça peut aussi faire pour la doc, mais ce n'est plus trop utilisé
- GFDL http://www.gnu.org/copyleft/fdl.html(...) : même si certains extrémistes ne la trouvent pas très libre
- Creative commons http://creativecommons.org/license/(...)
- Free Art license http://artlibre.org/licence.php/lalgb.html(...)
- OPL: http://www.opencontent.org/opl.shtml(...) OpenContent License
-
Quelle est votre opinion par rapport à la documentation des logiciels libres ?
Quelle est votre opinion par rapport à la documentation des logiciels libres?
J'ai souvent entendu des développeurs dire qu'il faut que ça soit des utilisateurs qui écrivent la doc...
- d'un côté ça arrange bien les développeurs, car ils n'aiment pas ça
- de l'autre ça permet d'éviter tout un jargon technique que le développeurs seraient tenté d'utiliser dans la doc, la rendant difficile à lire, et pas là-même, inutilisable...
-
[^]Re: Quelle est votre opinion par rapport à la documentation des logiciels libres ?
Posté par Olivier (page perso, ) le 06/05/2004 à 12:59. (lien). Évalué à 1.A défaut des utilisateurs finaux, on peut toujours se reporter sur les fonctionnels qui font les demandes et/ou équipes qui réalise la recette.
-
[^]Re: Quelle est votre opinion par rapport à la documentation des logiciels libres ?
Posté par Olivier (page perso, ) le 06/05/2004 à 13:02. (lien). Évalué à 1.(En fonction de la taille du projet)
-
Perso
Je trouve qu'il manque souvent de la documentation en français. J'ai par exemple essayé bastille il y'a peu, c'est très simple à mettre en place en mode interactif, mais c'est en anglais. Même quand on comprends l'anglais, c'est toujours beaucoup plus agréable de configurer un logiciel ou lire la doc dans sa langue natale. C'est pourquoi je me suis lancé sur une traduc libre de la doc d'icecast2, par exemple.
Avoir des fichiers de conf avec des commentaires localisés serait un gros plus également.
Quelqu'un pour traduire le HOWTO: write bad documentation that looks good ? :)
-
[^]Tradcution de HOWTO
Posté par Encolpe DEGOUTE (page perso, ) le 06/05/2004 à 12:54. (lien). Évalué à 2.Fait suivre sur traduc.org:
http://www.traduc.org/article.php?4.0(...)
Cette page a été générée par Templeet en 0.1187s (dont 0.0513 de SQL).
Cette page est peut-être conforme xhtml 1.0.
Information sur le site.
Faire un don !
Cette discussion est archivée, il n'est plus possible de laisser des commentaires.
Note : les commentaires appartiennent à ceux qui les ont postés. Nous n'en sommes pas responsables.