Rédiger des articles et organiser des collections
Votre Centre d’aide organise les articles au sein de collections et met à la disposition de votre équipe un éditeur de texte enrichi avec des liens internes, un historique des versions et des paramètres de visibilité.
Organiser les collections
Dans la barre latérale du tableau de bord, ouvrez Centre d’aide → Articles pour gérer l’arborescence de navigation.
Créez une collection. Cliquez sur Nouvelle collection dans la barre supérieure, saisissez un Nom (255 caractères maximum ; UserJot suggère automatiquement une icône au fur et à mesure que vous tapez, jusqu’à ce que vous en choisissiez une manuellement), choisissez une Icône, puis cliquez sur Créer. Les nouvelles collections apparaissent au bas du premier niveau.
Modifier une collection. Faites un clic droit sur une collection et sélectionnez Modifier… pour mettre à jour son icône, son nom ou sa Description (500 caractères maximum).
Imbriquer et réorganiser. Faites glisser les collections et les articles dans l’arborescence pour les réorganiser ou les imbriquer, ou faites un clic droit et choisissez Déplacer vers. Les collections peuvent être imbriquées sur trois niveaux maximum.
Articles de niveau supérieur et articles non classés. Les articles placés au Niveau supérieur apparaissent en dehors de toute collection et peuvent avoir une icône personnalisée (clic droit → Changer d’icône…). Cliquez sur Nouvel article dans la barre supérieure pour créer un brouillon non classé sous Aucune collection. Les articles non classés ne sont ni répertoriés ni accessibles par la recherche tant que vous ne les placez pas au Niveau supérieur ou dans une collection.
Supprimer une collection. Faites un clic droit sur une collection et sélectionnez Supprimer…. Les collections sont supprimées définitivement, sans passer par la corbeille. Si la collection contient des articles, choisissez de Déplacer ses articles vers une autre collection, le Niveau supérieur ou Aucune collection (si vous les déplacez dans une autre collection, les anciennes URL de la collection supprimée redirigent vers celle-ci).
Rédiger avec l’éditeur
Chaque article comporte un Titre obligatoire (255 caractères maximum), une Description facultative (500 caractères maximum, utilisée sur les cartes et comme méta-description) et un éditeur de contenu.
Appuyez sur / sur une nouvelle ligne pour insérer des blocs :
Texte, Titre (H2) et Sous-titre (H3). Les titres génèrent automatiquement des ancres de section stables.
Liste à puces, Liste numérotée, Citation, Bloc de code (avec sélecteur de langage) et Séparateur.
Image (importez des fichiers depuis votre ordinateur ; cliquez sur une image pour ajouter un Texte alternatif ou une Légende, chacun limité à 500 caractères).
Tableau (il se présente par défaut sous la forme d’un tableau de 3 × 3 avec une ligne d’en-tête et des commandes flottantes pour les lignes et les colonnes).
Encadrés Note, Conseil et Avertissement, ainsi que blocs Accordéon repliables (titres de 1 à 200 caractères). Dans l’éditeur du tableau de bord, les encadrés et les accordéons ne peuvent pas être imbriqués les uns dans les autres (via l’API ou l’importation HTML, un encadré peut apparaître dans un accordéon, mais les combinaisons encadré dans un encadré, accordéon dans un encadré et accordéon dans un accordéon sont refusées).
Vidéo intégrée depuis YouTube, Loom ou Vimeo (ou collez un lien brut vers l’un de ces services sur une ligne à part).
Sélectionnez du texte pour appliquer les styles Gras, Italique, Barré, Code, Touche (style de raccourci clavier) ou des liens. Les styles Code et Touche ne peuvent pas être combinés à d’autres marques de mise en forme en ligne, et le texte Touche ne peut pas contenir < ni >. Les documents acceptent jusqu’à 1 Mo de JSON, 512 Ko de Markdown, 5 000 nœuds et 32 niveaux d’imbrication de blocs.
Les brouillons sont enregistrés automatiquement pendant la saisie. Appuyez sur ⌘S / Ctrl+S pour enregistrer manuellement, sur ⌘⇧\ / Ctrl+Maj+\ pour afficher ou masquer le volet de la liste des articles, activez ou désactivez Aperçu dans le coin inférieur droit pour vérifier l’affichage côté lecteur, ou cliquez sur la commande Son de frappe en bas à gauche pour choisir des sons de frappe mécaniques (facultatifs) (Alpaca, Cream, Mint, Mochi, Frost ou Désactivé) et régler leur volume à l’aide du curseur.
Dialecte Markdown du centre d’aide
L’API REST, le serveur MCP, Copier la page et les points de terminaison .md utilisent la variante GitHub de Markdown, étendue avec les éléments suivants :
Blocs d’encadré
<Note>,<Tip>et<Warning>Sections repliables
<Accordion title="...">{#custom-id}à la fin d’un titre pour fixer une ancre stable<kbd>...</kbd>pour les touches de clavier en ligneLiens internes écrits sous la forme
/articles/<slug>ou/collections/<slug>(avec#headingen option)
Créer des liens entre les articles
Cliquez sur le bouton de lien dans la barre d’outils de sélection pour ouvrir Ajouter un lien. Recherchez des articles, des collections et des titres d’articles publiés dans votre centre d’aide (la recherche de titres nécessite au moins 2 caractères et renvoie jusqu’à 8 résultats), ou collez une URL externe https://. Si vous collez l’URL d’un de vos articles d’aide, elle devient une référence interne qui reste valide même si le slug de l’article cible change.
Si une cible liée est ensuite dépubliée, mise à la corbeille ou supprimée, l’éditeur met le lien en évidence dans le texte pour que vous puissiez le corriger. La liste Lié depuis dans le panneau Article à droite affiche jusqu’à huit articles publiés qui renvoient vers l’article actuel.
Gérer la visibilité, les liens et les mots-clés
Ouvrez le panneau Article à droite pour configurer la façon dont les lecteurs trouvent un article :
Paramètre | Fonction |
|---|---|
Visibilité | Choisissez Public (répertorié, accessible par la recherche et inclus dans |
Collection | Placez l’article au Niveau supérieur, dans une collection ou laissez-le sous Aucune collection. |
Lien | Cliquez sur |
Afficher dans les moteurs de recherche | Autorisez ou bloquez l’indexation de cet article par les moteurs de recherche. Pour être indexé, l’article doit également être public et placé, et votre centre d’aide doit être en mode En ligne. |
Mots-clés | Ajoutez des mots-clés de recherche masqués pour la langue actuelle (50 mots-clés maximum, 64 caractères chacun). Appuyez sur Entrée ou sur la virgule pour ajouter chaque terme. |
Vous pouvez également attribuer un Auteur (ou sélectionner Aucun auteur) dans la carte d’état en haut du panneau latéral droit.
Publication, historique et corbeille
Publier. Cliquez sur Publier (ou Publier les modifications, raccourci ⌘↵). Avant la mise en ligne, une fenêtre contextuelle signale les textes alternatifs d’image manquants et les liens internes rompus. Lorsque vous mettez à jour un article publié, désactivez Afficher comme mis à jour pour les petites corrections afin que la date de mise à jour publique reste inchangée.
Dépublier. Ouvrez Autres actions (
⋮) → Dépublier pour mettre hors ligne la langue actuelle tout en conservant son brouillon et son historique des versions.Historique des révisions. Sélectionnez une entrée sous Historique dans le volet de droite pour la consulter en lecture seule (appuyez sur Échap pour quitter l’aperçu), puis cliquez sur Restaurer cette version pour la copier dans votre brouillon (elle reste non publiée jusqu’à ce que vous cliquiez sur Publier les modifications).
Comparer les traductions. Lorsque vous modifiez un article traduit, activez Comparer dans la barre supérieure (sur les écrans larges) pour afficher côte à côte l’original publié et la traduction, avec les blocs modifiés, ajoutés et supprimés mis en évidence.
Mettre à la corbeille et restaurer. Ouvrez Autres actions (
⋮) → Mettre à la corbeille pour supprimer immédiatement un article. Les articles mis à la corbeille peuvent être restaurés pendant 30 jours (leur slug et leurs redirections sont réservés) avant leur suppression définitive. Lorsque vous ouvrez un article dans la corbeille, le bouton Restaurer depuis la corbeille s’affiche.
Étapes suivantes
Traduisez des articles dans plusieurs langues avec Langues.
Synchronisez vos articles publiés avec Juno dans Former Juno à votre produit.