Login About Glasnost

Freeduc-doc

Le projet Freeduc-doc concerne les aspects de documentation pour l'utilisateur final de Freeduc-cd. Il s'attache donc à produire et maintenir un corpus documentaire de qualité pour accompagner chacune des versions de Freeduc-cd que nous produisons. Le corpus est disponible sous les formes de documents sources au format ouvert en licence de documentation libre FDL. Il est également accessible directement en ligne. Sur ces pages vous apprendrez comment obtenir cette documentation et participer à son amélioration

Comment obtenir la documentation ?

Plusieurs options vous sont proposées : obtenir une version imprimée, consulter directement en ligne la documentation ou bien télécharger les sources de la documentation (voir la section Participer au travail de documentation dans cette page).

Version imprimée

Nous souhaitons encourager les gens à rejoindre OFSET afin de soutenir notre action. C'est pour cela que nous proposons à nos adhérents une version papier de la documentation, accompagnée d'un cédérom de Freeduc-cd. Pour en savoir plus allez dans notre page Adhésion.

Si vous souhaitez obtenir des versions imprimées en quantité, contactez notre secrétariat Adresse électronique du secrétaire.

Version en ligne

Documentations de Freeduc-cd disponibles dans diverses langues :

Participer au travail de documentation

Philosophie

Pour Freeduc-cd, nous souhaitons proposer pour chaque logiciel présent dans le cédérom une documentation. Cette documentation peut-être une simple présentation du logiciel ou bien quelque chose de plus exhaustif. Au final l'objectif est qu'un utilisateur de Freeduc-cd soit en mesure de savoir ce à quoi sert chaque application du cédérom.

Une participation au travail de documentation peut prendre différentes formes. Cela peut être un travail de relecture, l'écriture de nouvelles documentations, l'adaptation de documentations existantes. D'un point de vue légal, la documentation doit être sous licence libre Free Documentation License.

Aussi, participer à l'effort de documentation nous permet à tous de bénéficier d'une documentation de meilleure qualité. Que vous soyez enseignants, formateurs, parents ou simplement intéressé par le sujet, cette collaboration nous permet donc ensemble d'améliorer pas à pas ce bien commun.

Considérations pratiques

Le corpus documentaire de Freeduc-cd est organisé sous la forme de granules documentaires. Un granule est une unité de documentation correspondant généralement à une fiche documentaire d'un logiciel. Une sélection de granules peut ensuite être assemblée pour former un livre de Freeduc-cd particulier. Participer à l'effort de documentation revient donc à travailler sur un granule, ce qui est relativement simple et souple.

Les granules sont écrits à l'aide des langages de composition de texte LaTeX (version papier des documents finaux) et HyperLaTeX (version en ligne).

Le projet Freeduc-doc s'appuie sur le centre de développement Gna!, son adresse est http://gna.org/projects/freeduc-doc. Si vous souhaitez participer, il est fortement conseillé de vous enregistrer dans ce projet, dans ce cas contactez moi à Adresse électronique Hilaire pour voir comment faire.

Le corpus documentaire est hébergé dans un CVS (un système collaboratif de partage de documents) à http://gna.org/projects/freeduc-doc, pour participer il vous est donc nécessaire d'être familier ou d'apprendre à utiliser les outils CVS, SSH et LaTeX. Bien sur nous pouvons vous aider si nécessaire. Il est par ailleur possible de consulter le CVS de Freeduc-doc en ligne depuis http://cvs.gna.org/viewcvs/freeduc-doc/freeduc-doc.

Si vous avez quelques difficultés avec ces outils, nous proposons une autre approche par l'intermédiaire de l'espace wiki dédié à Freeduc-doc http://community.ofset.org/wiki/Freeduc-doc. Sur cet espace vous pouvez directement écrire des granules de documentation accompagnés de leurs images (format PNG uniquement). Un rédacteur se chargera ensuite de les convertir en LaTeX et de les intégrer dans le CVS de Freeduc-doc. Si vous êtes intéressé par cette option, contactez-moi directement à Adresse électronique Hilaire.

Important : cette approche bien que souple, souffre de deux problèmes. Elle nécessite un travail de conversion, et les modifications ultérieures sont un peu plus lourdes à gérer.