[icecast-dev] Documentation

[Pierre Amadio]

Hi there.

Some words to tell you that the documentation effort start taking shape.

A savannah project has been created in order to coordinate work:

http://savannah.nongnu.org/projects/interopcast/

CVS is accessible via cvsweb here:

http://savannah.nongnu.org/cgi-bin/viewcvs/interopcast/

A first html shot available for browsing here: (there are other
documents to merge with but not yet http available, to be coming)

http://melmoth.dyndns.org/stream/doc/

Interopcast will participate in documentation effort and in developpment
as one of its member is working in a computer school and is using icecast
enhancement as a student project (8 students will be working on it).

More news about this student work in some days.

Now for the documentation questions.

As several people have already began writing usefull documents about
icecast 1 or 2, we are trying to merge works in order to create a single
document that may end as an 'official' documentation.

Archives of mail about how this is going may be readable here:
http://mail.gnu.org/archive/html/interopcast-general/

Several questions have been asked and i'm sure icecast's developper may
have good ideas about what is to be done.

What's the average technical knowledge level of intended audience that
shall be presume for such a document ?

As i would be pleased to have several translations of the document, i
would like to have this document the most icecast specific as possible
(less translation work :) ).

Documentation format is now docbook, but a man compatible version would
also be interesting to have. Anybody knows if docbook2pod is something
easily done ?

How many document to create ? A proposed idea would be to have 3
differents ones:

- a general icecast presentation, sort of marketing like without
  technical stuff targeted at non technician taking decision about what
  software to use in their streaming project.

- a technical presentation targeted at administrator that have to
  install icecast and developper that intend to customize it.

- an exploitation document target at technician that have to use the
  software in production.

<p>I guess a good way of starting would be to agree on the number of
document to create, the table of contents for each one. Then we would be
able to divise work, share it amongst volounteer and once a correct
english version would be available start translating in several language
and man format.

Any ideas, suggestions ?

Have a nice day.

Pierre Amadio

<p><p><p>--- >8 ----
List archives:  http://www.xiph.org/archives/
icecast project homepage: http://www.icecast.org/
To unsubscribe from this list, send a message to 'icecast-dev-request at xiph.org'
containing only the word 'unsubscribe' in the body.  No subject is needed.
Unsubscribe messages sent to the list will be ignored/filtered.