La liste des tâches pour la documentation

Nous présentons ici des sujets sur lesquels travailler pour la documentation utilisateur.

Pendant le PBF, nous fournirons une feuille de calcul avec tous les sujets sur lesquels vous pouvez travailler. Vous pouvez inscrire votre nom sur cette feuille derrière un sujet sur lequel vous travaillez, pour éviter le travail en double.

Vous pouvez trouver une liste détaillée sur https://github.com/joomla/documentation/issues. Vous y trouverez également des discussions sur un sujet et des informations de contexte. Vous pouvez aussi y indiquer que vous travaillez sur un article spécifique, pour éviter que quelqu'un d'autre travaille sur le même sujet.

À l'honneur : pages de présentation

Quand vous regardez les explications dans le guide utilisateur, vous verrez qu'elles sont regroupées par sujet. Chaque sujet possède un article de présentation, vous informant du type d'informations que l'on peut trouver sur les pages sous-jacentes. Par exemple, sous Articles vous trouverez 25 pages expliquant toutes sortes de choses liées aux articles. Dans la page de présentation, ces pages sont introduites de manière structurée.

Voici une liste des pages de présentation manquantes. Plus il y a d'articles sous cette page de présentation, plus le besoin d'une bonne page de présentation est élevé.

À l'honneur : tutoriels sur la construction de site

Pour l'instant, nous nous concentrerons sur les tutoriels sur la construction de site. Des guides pas à pas montrant tous les concepts utilisés pour construire un site avec Joomla.

La manière dont ces tutoriels de construction de site sont structurés et quels articles existants du manuel utilisateur vous pouvez utiliser pour cela se trouvent dans cette feuille de calcul (travail en cours).

Vous pouvez en trouver plus dans tous les sous-éléments de ce ticket : ... à faire...

Voir le menu de gauche sur la page Tutoriels. Vous pouvez y voir à quoi peut ressembler un tutoriel.

À propos des tutoriels

Un tutoriel n'est presque jamais complet. Il montre simplement une façon de faire quelque chose, et non toutes les possibilités alternatives pour le faire.
Le but principal est de montrer certains concepts que vous souhaitez enseigner. Pas de longues explications. Un tutoriel, c'est apprendre en faisant.
Le tutoriel propose une série d'étapes que le lecteur peut reproduire, menant à un résultat reproductible. Le chemin est cependant plus important que le résultat.
ordre fixe :
- Commencer par un aperçu des prérequis : quels tutoriels doivent être faits avant de faire celui-ci.
- Ensuite un résumé du sujet de ce tutoriel (décrivant brièvement l'exemple).
- Puis les étapes à suivre
- Terminer par une conclusion : résumé des concepts abordés.

Autres sujets sur lesquels vous pourriez travailler :

Champs personnalisés.
Guides pratiques avec mod_articles.
Tutoriel : Ajouter un module au tableau de bord.
Surcharges de template.
Articles de magazine utiles.

Champs personnalisés

Nécessaire :

un tutoriel expliquant comment utiliser les champs personnalisés ; actuellement : https://docs-core.sandbox.joomla.org/user-manual/fields/fields-fields-and-field-groups
Parmi tous les articles actuellement sous « champs », il y a 4 articles généraux (champs et groupes de champs, paramètres des champs, sites multilingues et surcharges de template). Ils sont au même niveau que les 15 types de champs personnalisés et un article sur un champ personnalisé spécial : le sous-formulaire. Peut-on trouver une meilleure structure plutôt que de mettre tous ces articles au même niveau ? S'il faut un niveau plus profond, ne pas oublier la page de présentation.
un guide pratique expliquant comment répéter des champs personnalisés (à l'aide d'un sous-formulaire).
un exemple d'utilisation de sous-formulaires imbriqués dans les champs personnalisés (nouveauté depuis la 5.2).
une référence (présentation) de tous les champs personnalisés + une courte description.
un tutoriel sur les surcharges de template. Voir https://docs-core.sandbox.joomla.org/user-manual/fields/fields-adding-custom-fields-overrides

Voir la série sur les champs personnalisés par Marc Dechèvre dans le Magazine :