Rebol Documentation Project

(Historique)

Le REBOL Documentation Project a pour objectif de structurer l’accés à la documentation existante, de développer de la documentation libre pour le language de programmation REBOL et ainsi d’augmenter la visibilité du langage. Ce développement inclura la création de “Howtos”, de dictionnaires, de manuels, d’articles techniques, de news, etc… Nous esperions établir une système de consultation simple à utiliser et facilitant les recherches, c’est maintenant chose faite, esperons-le.

Le REBOL Documentation Project est basé sur le travail d’une équipe de volontaires et d’une organisation centralisée minimum. Tout le monde est invité à participer à l’effort commun.

Le site du projet est maintenant plainement fonctionnel et en production. N’hésitez donc pas à lui faire l’honneur d’une visite !

Rebol Documentation Project : http://rebdocproj.sourceforge.net

Afin de disposer d’une base de discussion, une analyse préalable à déjà été réalisée sous forme de MindMap. Celui-ci est disponible sur simple demande à reboltof@yahoo.com

Core

• Core 2.3 Release Notes
• Core 2.5 Release Notes
• REBOL Dictionnary (9-mar-2004)
• Core User Manual (2.3)

View

• View Developpers Guide (View 1.0 du 5-April-2001)
• Beginners Guide (View 1.0 du 5-April-2001)
• Draw Dialect (2-Jan-2003)
• Desktop (REBOL/View 1.1 du 26-Apr-2001)

Pro

• Encryption (5-Aug-2003 )
• External libs (5-Aug-2003)
• Shell (5-Aug-2003)
• Sound (5-Aug-2003)

Command

• Reference Command 2.5 (5-Aug-2003)

IOS

SDK

• Reference SDK 2.5 (5-Aug-2003)

Other

• CGI (12-Mar-2003 )

Site

• Carl’s Blog (http://www.rebol.net/cgi-bin/blog.r)
• http://www.codeconscious.com/rebol/
• http://rebol.agora-dev.org/
• REBOLFrance
• REBOL.com
• REBOL.org
• http://www.programmationworld.com/
• http://www.robertmuench.de/
• http://www.spinodo.org/
• http://www.mustard.co.nz/rebol/
• http://homepages.tesco.net/~phil.bevan/rebol/rebol.html
• http://www.rebolforces.com/
• http://www.rebol.it/~steel/

Wiki

• http://www.compkarori.com/cgi-local/vanilla.r
• http://www.spinodo.org/

Forum

• http://www.programmationworld.com/
• http://www.codeur.org/forum/forum.php?theme=17

Mailing-list

• http://www.escribe.com/internet/rebol/index.html

Forme

Formatage

• MakeDoc

Stylesheet !

• MakeDocPro

Stylesheet !

• OpenOffice Writer

Rubriques

Standarisations

Style Guide !

Niveaux

• Beginner
• User
• Advanced user
• Expert
• Guru

Contributions

Volontaires

• Inscrits
• Non-inscrits

Professionels

• RT

Principes

• “Single point of entry”
• Structured
• Up-to-date
• Open to contributions
• Pas perdre de temps avec la forme, mais s’occuper du contenu !!!

Contenu

Classement

• Bugs
• News
• Articles techniques
• dictionary

help on individual functions

wiki ?

• faq
• guide

longer, in depth doc

• How-to
• Specific-subject help

What?

• Link vers l’existant
• Création de l’inexistant

traductions !!!

• web-translation
• static

qui ?

• Toutes les bonnes volontées.

[REBOLtof] Je mentionne ici une liste non-exhaustive de moyens possibles…

1. Wiki

2. Static Doc * Doc HTML Statique (traduction de la doc officielle p.e)

3. CMS * Zope * SPIP * Magic!-based

1. REBOLFrance.info
2. REBOLFrance.org
3. SourceForge
4. LDCI

1. REBOLTalk
2. Google Group
3. Yahoo Group
4. SourceForge

1. Official RT ML
2. Sourceforge

1. Books
2. White papers
3. User/Tech Manuals

1. Contribution perso
2. Publicité
3. Donation
4. Soutient d’une unif…

( à compléter)

Outils déjà en place pour la plupart, prêt à l’emploi:

1. Différents trackers (bugs, features, patches et support)
2. CVS
3. Espace web (PHP, Perl? MySQL,…)
4. Espace documentation projet
5. Gestion des releases
6. Mailing List, forum
7. Gestion des droits d’accès

Outre ces aspects pratiques, SF offre au projet une grande visibilité… dont REBOL a bien besoin !

A voir. qq arguments ont déjà étés développés.

Shad a un peu exploré cette piste…

rebol qui n’a pas connu depuis un certain temps de nouveautés notables. On peut aussi s’associer avec les auteurs initiaux de vinilla pour aller encore plus vite (enfin si ca les interresses). — Alphé Salas-Schumann 06/02/2005 06:55

Christophe Coussement 07/02/2005 10:14

Trop limité en visibilité, et en nombre de personnes pouvant intervenir.

Un peu difficile de savoir ce que l’on veut d’avance. Temps d’attente de l’outil trop long. Par contre, cela peut être un but sur le long terme.

quels sont les objectifs poursuivis par une mise sous licence de la nouvelle documentation produite ? — Christophe Coussement 03/02/2005 09:27

• offrir une protection à nos travaux:
  • empêcher l’exploitation commerciale de notre travail de volontaire
  • empêcher des transformations non-souhaitables
• “récompenser” le travail de volontaires par la citation de leur nom (c’est un minimum non ?)

Christophe Coussement 07/02/2005 10:20

quelle licence utiliser pour la nouvelle documentation produite ? Avantages ? Désavantages ? — Christophe Coussement 03/02/2005 09:27

• http://creativecommons.org/licenses/by-nc-sa/2.0/ (proposé par ‘nuts) Christophe Coussement 07/02/2005 10:16

Avantages

• visibilité
• gratuité
• nombre d’instruments mis à disposition (voir plus haut)

Désavantages

• mise en oeuvre demande certaines connaissances informatiques (linux, ssh, putty, cvs, …)
• projet doit rester libre (mais est-ce un problème ?…)

Afin de :

• conserver les versions des travaux en cours (traduction, nouvelle doc, …)
• permettre l’édition simultanée d’un même doc
• conserver l’historique des travaux

Afin de :

• publier les releases officielles des travaux produits

Afin de :

• gérer les demandes d’amélioration (“features”) provenant d’utilisateurs
• gérer les bugs remarqués par les utilisateurs

Afin de :

• créer un look plus “agréable” que le portail de SourceForge
• donner accès via des links aux informations sus-mentionnées

il conviendra à terme d’au moins fournir les versions US et FR du site …

Rubriques

(Là j’avoue m’être fortement inspiré du site http://tldp.org … à vous de juger de l’opportunité de ces rubriques …)

• RDP Info

• FAQ
• License
• Mailing List
• Request / Bugs
• Feedback

• RDP Auteur

• RDP Guide de l’auteur
• Contribution / Aide
• Documents en progrès
• Documents cherchant auteur
• Comment soumettre ?
• Utiliser le CVS
• Téléchargements
• Contacts

• RDP Documents

• HOWTOs : description courte et souvent informelle sur la méthode à appliquer afin d’accomplir une tâche donnée. Ils sont généralement destinés à des non-experts et ne s’attardent pas sur les détails qui sont important pour les experts.
• Articles techniques : contrairement aux HOWTOs, ceux-ci s’adressent à un public d’initiés. Ils traitent en profondeur d’un sujet particulier.
• Dictionnaire : comme sont nom l’indique, il s’agit d’une compilation des explications des mots REBOL, à l’instar de http://www.rebol.com/docs/dictionary.html. Mais notre dictionnaire devrait être présenté sous la forme d’un wiki (dokuwiki, mediawiki,… ?) afin de permettre à tous d’apporter des modifications.
• Guides Techniques : compilations de plusieurs articles techniques traitant d’un même contexte.
• Guides Utilisateurs : principalement les traductions des guides officiels existants.

• News

• Dernières nouveautés du site
• Dernières nouveautés REBOL

SF ?

• 15 février, pose du premier mot ?

Le genre de truc en Pdf, HTML, ou autre qu’il serait possible d’avoir sous le coude pour présenter le langage à des managers potentiels, donc avec aussi des exemples de réalisations concrétes. Le press-book du rebol, quoi . — Philippe Le Goff 03/02/2005 14:22

Sans doute serait-il judicieux de poser cette question sur Altme ou à Carl : histoire d’avoir une vue d’ensemble de réalisations probantes d’usage de Rebol ? — Philippe Le Goff 07/02/2005 11:09