L’équipe de la « documentation officielle Â» est en place!

Comme certains d’entre vous le savent déjà, XOOPS compte maintenant sur une équipe affectée à la rédaction de la documentation officielle, et ce, depuis la fin de 2003. Cette équipe s’est donnée pour mission de développer une documentation exhaustive de qualité, s’adressant à tous les intervenants qui font de XOOPS ce qu’il est. Des développeurs jusqu’aux administrateurs de sites xoopsés, en passant par monsieur et madame Tout-le-Monde qui navigue sur un ce ces sites. Tous y trouveront leur compte.

Comme l’équipe de documentation regroupe des gens de divers pays, nos travaux s’effectuent uniquement en anglais. Xoops-France étant la communauté où nous retrouvons le plus de documentation, nous entrevoyons très bien l’adaptation des documents issus de nos travaux pour le public francophone.

En tant que membre de cette équipe de documentation, il me fait plaisir de vous brosser un bref tableau de la situation actuelle : où en sommes-nous? sur quoi travaillons-nous? qu’est-ce qui s’en vient?

Le commencement…

Tout d’abord, la fin de 2003 et le début 2004 nous a permis de déterminer ce que nous voulions faire, et comment nous allions le faire. L’élément principal qui est ressorti de notre réflexion est évidemment le très haut standard de qualité que nous désirons offrir. XOOPS possédant lui-même un très haut standard de qualité, il était impensable de ne pas maintenir le même standard pour la documentation. De ce fait, nos réalisations nécessiteront un peu plus de temps, mais nous vous assurons que les résultats seront à la hauteur de XOOPS.

Une introduction visuelle à XOOPS

Nous avons finalement complété le document A Visual Introduction to XOOPS [XN-001] ou encore Une introduction visuelle à XOOPS. Ce document a pour but de présenter XOOPS et de démontrer de façon visuelle ce qu’il peut faire. En quelque sorte, on pourrait comparer ce document à un genre de brochure publicitaire détaillée. Si je n’étais pas déjà vendu corps et âme à XOOPS, la lecture de ce document, m’y aurait convaincu (lol) !

Nous en sommes à l’adapter à différent format (CHM, HTML, PDF) et à le faire circuler à l’interne pour corriger les derniers petits trucs. Ça reste une version de type brouillon (Draft) pour l’instant et nous désirons connaître l’avis du public. Le document sera publié sur le site officiel de XOOPS dans quelques jours.

Simples FAQs pour les nouveaux Xoopsers

En plus de l’intro visuelle, nous avons presque complété le document Simple FAQ’s for new Xoopser [XU-209]. Ce document s’adresse à monsieur madame tout le monde mentionné plus haut.

Bien que XOOPS soit un des CMS les plus conviviaux, il reste toujours que l’Internet en général n’est pas facile pour le commun des mortels! Ça peut paraître banal pour la plupart d’entre nous d’inscrire un message dans le forum de discussions ou de proposer un téléchargement ou encore de publier un article, mais ça ne l’est définitivement pas pour tous. Voilà donc ce qu’expliquera ce document!

Présenté sous forme de question et réponses, le document Simples FAQs pour les nouveaux Xoopsers répond à presque toutes les questions de base de chacun des modules officiels de XOOPS. Il nous reste à finaliser ce document ainsi qu’à trouver une présentation intéressante. Nous entrevoyons bien un genre de script qui ajouterait toutes ces questions et réponses dans un module comme WF-FAQ ou XoopsFAQ.

À venir prochainement sur vos écrans…

Parallèlement à ces deux documents, nous travaillons également sur près d’une dizaine d’autres dont les plus avancés sont ceux-ci :

• XOOPS Installation Guide" [XU-002] : Guide d’installation de XOOPS. Ce document, comme son nom l’indique s’adresse aux administrateurs de sites qui désirent installer XOOPS. On y retrouve toutes les étapes de son installation sur plusieurs plates-formes.

• XOOPS Operations Guide" [XU-003] : Guide d’opération de XOOPS. Ce document s’adresse aussi aux administrateurs de site xoopsés et se veut un guide pratique de l’administration quotidienne du site. Y sont expliquées toutes les fonctionnalités de l’administration du site.