You are here

Documentation project

Hi all,

Many thanks to the developpers for this great software.
Could someboy tell me if a documentation project is already running.
Even if I am not a specialist of the Jabber clients, I could help to the creation of a user manual. The only problem is that I only write and translate correctly (English or German) in French.
A+
--
gw

Forum: 

Hi,

there is no real documentation project running yet. The documentation that is available is in the "Documentation" area in the home page, or some small hints in the "Tip of the day" in coccinella itself.
You think of a manual like a PDF file or some structured web pages?

Sebastian

There are also the screencasts. If you are interested, you can translate the subtitles to French. However, as the screencasts are a little outdated, updated/new screencasts need to be made in the future. Are you interested in this task?

Hi,

@ Sebastian
I've posted a draft here : http://www.softenpoche.com/sep/Coccinella/index.html
Please, consider it as a non finished document, some things have to be added/changed/controlled.
I think the format should be an usual one (PDF, html, .doc,...?) so that other contributors can easy modify the document, but it's your decision. This draft is made with exelearning only because I have to evaluate this soft (I'm searching to collect a set of Elearning tools easy to use for teachers who are not unbedingt « computer fans »).
For me, a document in English should be the official version so that other contributors could translate it in their own language, but it's only my opinion.

@ sander
Screencasts are effectively useful to illustrate some functions. Why not, but with which software, "wink"? Another one? If possible an easy one, to allow other contributors to work with.

A+
--
gw

Hi,

this looks not too bad, but is written in french, so I don't understand a word at all ;)

Whatever comes out of it, i.e. pdf, .html, ... in case there is special software needed to open the sources, and make changes, this software should be available for at least Windows/MAC/Linux/*BSD. So exelearning seems to be fine, there are packages for Linux/MAC/Windows available, and for others there are sources.

I haven't checked it out yet, but how easy is it with exelearning to support multiple languages?

I think all documentation is best stored at /documentation. When Drupal 7 is released, we will upgrade. This version supports pages in multiple languages. For screencast creation, I have some draft documentation inspired by https://wiki.ubuntu.com/ScreencastTeam/RecordingScreencasts . After the website upgrade, I will look into html5 first to see if there exists a script for subtitles. In this way we can get rid of Flash (@Sebastian: I guess you will like this on your OpenBSD system :-) ).

Like XMPP is a free protocol, also the website should stick to free protocols/technologies. At least for me on OpenBSD flash would be a no-go ;)

Sebastian