Freeduc-doc
The Freeduc-doc project is about documentation for the Freeduc-cd end user. Therefore its goal is to produce and to maintain a quality documentation corpus to come with each Freeduc-cd version we are producing. The corpus is available as document on open format and the free documentation license (FDL). It is also accessible on-line. On these pages you will learn how to get the documentation and to participate to its improvement
How to get the documentation?
You have several options: a printed version (only French for now), on-line documentation or the documentation source (see section How to help the documentation effort? in this page).
Printed version
We want to encourage people to join OFSET to support our action. Therefore we are proposing to our member a printed version of the documentation, coming with a Freeduc-cd. To know more about this possibility read the Membership page.
If you are interested on printed version in quantity, contact our secretary
.
On-line version
Freeduc-cd documentations are available in various languages:
How to help the documentation effort?
Philosophy
Within Freeduc-cd, we want each software to come with a minimal documentation. This documentation can be a simple presentation of the software or an exhaustive one. At the end, a Freeduc-cd user should be able to get an overall picture of the software coming within the cd-rom
Participating to the documentation effort can take different forms. It can be a review work, writting new documentations or adapting existing documentations. From a legal point of view, the documentation must come under the Free Documentation License.
Joining the effort allows to all of us to benefit a better documentation. If your are teachers, trainers, parents or simply interested by the subject, this collaboration will provide step by step an improved common good.
Practical considerations
The Freeduc-cd documentation corpus is organised as documentation granules. A granule is a documentation unit matching a software documentation file. Granule selections can be assembled to produce one specific Freeduc-cd book. Therefore, participating to the documentation effort means working at the granule level, it is light and easy.
The granules are written with the text composition languages: LaTeX (printed version) and HyperLaTeX (on-line version)
The Freeduc-doc project use the Gna! development center, its address is
http://gna.org/projects/freeduc-doc.
If you are willing to help, it is strongly suggested you register yourself
in this project. In this case contact me at 
to know how to do it.
The documentation corpus is hosted in CVS (a collaboration system to share documents) at http://gna.org/projects/freeduc-doc, to participate it is necessary you get use with the CVS, SSH and LaTeX tools. Of course we can help you if necessary. It is also possible to read on-line the Freeduc-doc CVS from http://cvs.gna.org/viewcvs/freeduc-doc/freeduc-doc.
If you have some difficulties with these tools, we are proposing another
way throught the use of the Freeduc-doc wiki http://community.ofset.org/wiki/Freeduc-doc. From
this space you can directly edit documentation granule with pictures (only
PNG format). Later, a redactor will convert your document to LaTeX and
upload them in the Freeduc-doc CVS. If you are interested by this option,
contact me at .
Important : this last method is simple, but it suffers two problems. It requires conversion work, and next modifications can be uneasy to manage.
