Un extrait est un bloc de contenu réutilisable : texte, paragraphes, tableaux, images, signalements, blocs de code, ou toute combinaison que vous créez une fois et insérez dans plusieurs articles. Lorsque vous mettez à jour un extrait, le changement se reflète automatiquement dans chaque article qui l’utilise. Les extraits sont stockés dans une bibliothèque centrale au sein de Document360 et sont invisibles comme élément séparé pour les lecteurs. Sur le site de la base de connaissances, le contenu par extraits est affiché comme contenu d’article classique.
Pourquoi utiliser des extraits
Les extraits répondent à un problème courant de documentation : le contenu qui apparaît dans plusieurs articles doit être maintenu à plusieurs endroits. Sans extraits, mettre à jour un avertissement produit, un bloc de contact support ou un avertissement partagé signifie trouver chaque article qui le contient et éditer chacun individuellement. Une instance manquée conduit à des informations incohérentes.
Avec des extraits, ce contenu vit au même endroit :
- Unique source de vérité. Une modification, des mises à jour constantes partout.
- Réduction des frais de maintenance. Pas de recherche de contenu répété dans les articles.
- Une constance à grande échelle. Le même avertissement, note ou étape apparaît de manière identique dans tous les articles.
- Rédaction plus rapide. Les auteurs insèrent des blocs prédéfinis au lieu de retaper ou copier-coller.
Extraits vs. variables
Document360 propose deux outils de réutilisation de contenu. Le choix du bon dépend de ce que vous réutilisez.
| Extraits | Variables | |
|---|---|---|
| Type de contenu | Des blocs formatés tels que paragraphes, tableaux, images, callouts et code. | Des valeurs en texte brut telles que les noms, les chiffres, les URL et les phrases courtes. |
| Utilisation typique | Avertissements, étapes partagées, blocages de contact, avertissements répétés. | Noms de produits, numéros de version, adresses e-mail de support. |
| Limite de caractères | Pas de limite de caractères. | 300 caractères. |
| Peut-elle contenir la mise en forme ? | Oui, mise en forme complète de l’éditeur. | Non, uniquement par texto. |
| Peut-on nicher d’autres fragments ? | Oui, uniquement des extraits Markdown. | Non. |
| Inséré via | Structure de la barre d’outils ou de fusion de codes. | Barra d’outils, syntaxe de fusion de code ou commande de barre oblique. |
Commencez avec Snippets
Créer et gérer des extraits
Créez un extrait, choisissez votre éditeur, utilisez Eddy AI pendant la rédaction, et gérez les extraits de la page Extraits — modifier, supprimer, supprimer en masse et voir les dépendances.
En savoir plus →Utiliser et traduire des extraits
Insérer des extraits dans les articles en utilisant trois méthodes, traduire des extraits pour des bases de connaissances multilingues, et résoudre des problèmes courants.
En savoir plus →Meilleures pratiques
- Utilisez des extraits pour le contenu qui apparaît dans trois articles ou plus. Si le même bloc n’apparaît qu’à un ou deux endroits, les modifier directement est plus simple que de créer et gérer un extrait.
- Gardez chaque extrait concentré sur un seul objectif. Un extrait qui remplit une fonction spécifique comme un avertissement, un bloc de contact ou un avertissement partagé est plus facile à réutiliser et à mettre à jour qu’un snippet qui regroupe du contenu non lié.
- Nomme des extraits descriptifs. Utilisez un motif de nommage qui reflète le type de contenu et l’objectif, par exemple
[Warning] Unsaved changesou[Contact] Support block. Des noms cohérents facilitent la lecture de la bibliothèque et réduisent le risque d’insérer le mauvais extrait. - Vérifiez les dépendances avant de modifier ou supprimer. Les modifications apportées à un extrait s’appliquent immédiatement à tous les articles qui l’utilisent, y compris ceux publiés. Utilisez la colonne Utilisé dans pour examiner l’impact avant d’apporter des modifications.
- N’utilisez pas de variables dans les extraits. Les variables à l’intérieur des extraits ne s’affichent pas correctement dans l’aperçu de l’éditeur ni dans les exportations PDF. Gérez les valeurs dynamiques séparément du contenu des extraits.
- Traduisez des extraits en même temps que les articles. Si votre base de connaissances supporte plusieurs langues, traduisez des extraits en même temps que les articles qui les utilisent. Un extrait sans traduction affichera la valeur de la langue par défaut aux lecteurs d’autres lieux.