7 minutes reading time (1391 words)

Documentation Joomla!

Documentation Joomla!

Joomla! Nous avons un problème! Tout le monde est d'accord que la documentation Joomla! pourrait être améliorée. Nous n'allons pas nous attardez sur ses lacunes. Nous préférons écrire une nouvelle approche et décrire ses bénéfices tout en parcourant les difficultés actuelles. Cet article est destiné à vous stimuler. Si vous pensez qu'il y a un problème que nous n'avons pas traiter, merci de nous en faire part en utilisant les commentaires en dessous de cet article. Nous aimons vos remarques. Nous avons besoin de vos remarques. Nous avons besoin de votre aide. Merci pour votre participation.

Une nouvelle approche

de Tony Davis et Jon Neubauer
traduit en français par Pierre-André Vullioud et JCR

Notre proposition

  1. Utilisez Joomla!

    Joomla! Est-ce qu'un Système de Gestion de Contenu. La documentation c'est du contenu. C'est aussi simple que ça.

    • Améliorer l'ergonomie - L'un des principaux avantages d'un CMS, c'est sa capacités à utiliser des modèles. Nous pouvons changer la lisibilité des articles tout simplement en ajustant le modèle. Vous n'aurez plus à vous tordre le cou à lire la page.

    • Améliorer la recherche Smart Search indexe le contenu et cet index est disponible pour la recherche. Beaucoup d'utilisateurs utilisent Google pour trouver ce qu'ils désirent dans la documentation Joomla (wiki). Nous avons des doutes que l'indexation du wiki par Google n'est peut être aussi efficace qu'elle pourait l'être.

    • Améliorer la structure Nous pouvons apprendre de la réussite des autres. Nous aimons la présentation de la documentation MySQL. Les éléments essentiels que nous aimons sont:

      • Le menu titre s'adaptera au style Joomla!
      • Un selecteur de version est disponible sur toutes les pages. Mais MySQL diffère de Joomla! en offrant plus de versions avec des changements plus lents. Nous n'avons pas besoin de plus de trois versions avec une nouvelle release tout les six mois.
      • La table des matières de la version actuelle est visible sur la droite. Quand vous parcourez le contenu, elle se développe pour suivre votre cheminement dans la documentation.
      • La page d'accueil de chaque version propose plusieurs méthodes pour classer le contenu.
      • Chaque page de chapitre, par exemple 11.3, affiche un menu avec les différents sous chapitre avec une description sur leur signification et leur usage.
      • Recherche est disponible pour l'ensemble du site MySQL, la documentation de cette version ainsi que d'autre ressources.Mais nous aimons aussi le PHP sur la capacité de la page pour changer de langue et de leur option de commentaire. Essayez un commentaire sur PHP. Nous aimons ça.Améliorer l'internationalisation Les capacités du core asspciées avec Josetta nous permet de créer des pages correspondantes en différentes langues. Si nous créons thispage.html en anglais, puis nous la traduisons en français sur thispage.html, un utilisateur peut sélectionner l'indicateur de langue pour se déplacer entre ces deux pages. Il ne sera pas nécessaire de passer par la page d'accueil du site.

    • Améliorer le confort contributeurs Les auteurs de notre documentation seront des utilisateurs de Joomla! Ils sont familiarisés avec les interfaces et les méthodes d'utilisation des éditeurs. Pas besoin d'apprendre la syntaxe wiki et des conventions.

    • Améliorer la traduction L'utilisation des fonctions multilingues de Joomla! combiné à Josetta permet aux bénévoles de facilement contribuer dans leur langue.

  2. Cibler différentes communautés d'utilisateur

    Joomla! Documentation répond aux besoins de différent utilisateur. Notre effort devrait favoriser chacun d'eux. Nous imaginons plusieurs composantes:

    • Recettes - Comment faire cela?

      • Les pages actuelles sont décrittes avec précision, mais le lecteur n'est pas aidé à comprendre pourquoi une option pourrait être préférée à une autre. Les recettes aideront les débutants à construire leur premier site web et les développeur pour comprendre comment relier certains éléments au core de Joomla!

    • Explications - Pourquoi une approche et meilleure qu'une autre?

      • Joomla! est extrêmement flexible. Magnifique. Mais pour un débutant, c'est intimidant. Ils ont besoin d'aide pour faire des choses simples avec efficacité. Au fur et à mesure de leur progression, Il vont apprendre à faire des choses plus complexe.

    • Diagnostics Aide pour l'utilisateur débutant

      • Les utilisateurs avancés de Joomla! ont une approche efficace pour résoudre les problèmes. Les utilisateurs moins expérimentés peuvent avoir des problèmes pour définir leur question. Est ce que les utilisateurs débutants pourrait être assisté en leur offrant des liens sur des informations utiles ? C'est un défi technique pour un Joomla! développeur-.

    • Documentation Les descriptions détaillées

      • Le manuel de référence pour ceux qui ont une certaine expérience de Joomla!

  3. Définir une structure claire

    La structure de la documentation doit être, autant que possible, identiques d'une version à l'autre. Les utilisateurs pourront apprendre à utiliser cette structure et, par conséquent la trouver plus simple à utiliser. Nous espérons que les utilisateurs contribuent à l'amélioration de la structure. La possibilité de commenter la documentation, même si il cela nécessite une modération, vous donnera des informations utiles pour l'améliorer.

  4. Construire un modèle de documentation pour Joomla! 2.5

    Réaliser un prototype pour la documentation de Joomla! 2.5. Cette première version est basic. Elle sera amélioré dans les This email address is being protected from spambots. You need JavaScript enabled to view it.. Nous avons besoin de votre aide dans plusieurs domaines. Ecrire à This email address is being protected from spambots. You need JavaScript enabled to view it. pour obtenir un accès.

    • Commenter sur la structure proposée
    • Contribuer sur le contenu des pages
    • Commenter le contenu actuel
    • Traduire le contenu à l'aide de Josetta

  5. Construire des traductions en plusieurs langues

    Une fois que nous avons des pages, nous pouvons copier la structure dans une langue étrangère. Elle devient alors accessible à Josetta. Un traducteur voit la page d'origine et un formulaire vierge. Nous avons jusqu'ici utilisé Google translate pour créer un brouillon, puis le traducteur - quelqu'un qui connait Joomla! et qui rédige dans sa langue maternelle - édite le brouillon pour créer un document final.. Il est également nécessaire de remplacer toutes les images avec des images équivalentes dans la langue de destination. Nous désirons indiquer sur chaque page le niveau de traduction à l'aide d'un drapeau sur une échelle de 5 points. Nous croyons qu'une traduction même partielle peut aider quelqu'un qui n'est pas fort en anglais à comprendre un point particulier. Si vous voulez nous aider pour ce travail de traduction, vous pouvez contacter Tony Davis.

  6. Faire évoluer le modèle 2.5 vers Joomla! 3.0

    Maintenant cela devient intéressant.Nous prévoyons de terminer ce travail pour le début du mois d'août 2012. POUR CELA NOUS AVONS BESOIN DE VOTRE AIDE. Le version Joomla! 3.0 atteint un bon niveau de maturité seuls des changements mineurs sont désormais autorisés. Nous allons suivre le processus suivant :

    • Dupliquer les pages dans toutes les langues dans un Joomla 3.0
    • Copier les images dans un répertoire Joomla! 3.0
    • Demandez aux contributeurs anglais à se mettre au travail

  7. Consolider le modèle anglais de Joomla! pour en assurer la validité

    Nous prévoyons de traiter les pages en anglais de la nouvelle version de la même manière que nous traitons pages traduites dans d'autres langues. Elles utiliserons un drapeau indiquant de qualité de documentation. Sont-elles techniquement correct? Ont-elle été approuvés par un éditeur ? Les images sont elles correctes ? Nous espérons pouvoir terminé ce travail de sorte qu'une nouvelle version anglaise de la documentation Joomla soit disponible environ deux semaines après la sortie de Joomla! 3.0

  8. Suivez rapidement des traductions.

    La traduction peut commencer dès que les pages en anglais ont été vérifiées. Le drapeau sur la page anglaise montrera la progression de la traduction. Les traducteurs peuvent travailler en parallèle avec leurs collègues de langue anglaise. Nous espérons avoir les premières versions en langues étrangères de la Documentation Joomla! environ un mois après la sortie de Joomla! 3.0.

    Il s'agit d'une entreprise importante. Avec votre aide et votre soutien, nous continuerons à faire de mieux en mieux. Avec votre aide et participation, nous pourrons l'améliorer constamment).

    Joomla! est une communauté. En tant que communauté, nous pouvons rendre notre CMS préféré plus fort. Merci de contribuer.

    Le mois prochain, nous allons publier d'autres articles sur les implications d'un tel projet ainsi que sur les défis futurs.

Some articles published on the Joomla Community Magazine represent the personal opinion or experience of the Author on the specific topic and might not be aligned to the official position of the Joomla Project

0
Simplify Your Workflow with a PMS
Simple Security Guide, Part 1
 

Comments

Already Registered? Login Here
No comments made yet. Be the first to submit a comment

By accepting you will be accessing a service provided by a third-party external to https://magazine.joomla.org/