Skip to content

Latest commit

 

History

History
92 lines (52 loc) · 6.8 KB

File metadata and controls

92 lines (52 loc) · 6.8 KB
source-git-commit workflow-type source-wordcount ht-degree
15070ea99308741242b43206ed69cf1dbddca890
ht
719
100%

Directives relatives à la contribution à la documentation d’[!DNL Adobe Experience Manager]

Philosophie de la documentation

Nous savons que les utilisateurs d’[!DNL Adobe Experience Manager] travaillent dans des environnements très concurrentiels, afin de créer des expériences numériques qui les distingueront de leurs concurrents. Lorsqu’Adobe fournit de nouveaux outils avancés dans [!DNL Experience Manager], il est essentiel qu’ils soient complétés par une documentation précise et claire pour permettre au client d’exploiter immédiatement son investissement dans [!DNL Experience Manager] et maximiser le ROI.

L’objectif de la documentation d’[!DNL Experience Manager] est de la placer entre les mains des utilisateurs d’[!DNL Experience Manager] dès que possible. Nous privilégions donc une documentation précise et utilisable, et nous la mettons à jour et l’améliorons constamment.

Contributions à la documentation

Pour améliorer continuellement la documentation d’[!DNL Experience Manager], toute la communauté des utilisateurs d’[!DNL Experience Manager] peut apporter sa contribution. Que ce soit par le biais de demandes d’extraction ou de demandes, les améliorations apportées à la documentation peuvent être des corrections, des clarifications, des extensions et des exemples supplémentaires.

Normes de la documentation

Bien que nous nous félicitions des apports à notre documentation, toute contribution à la documentation d’[!DNL Experience Manager] sous la forme d’une demande d’extraction ou d’un problème doit être conforme à nos normes de contribution et de documentation.

Les contributions qui ne satisfont pas à ces normes peuvent être rejetées.

Nous documenterons les cas d’utilisation standard

La documentation d’[!DNL Experience Manager] couvre les cas d’utilisation standard. Les cas d’utilisation au-delà de la portée de l’installation et de l’utilisation standard du produit ne font pas partie de la documentation d’[!DNL Experience Manager].

En général, nous ne documentons pas les bogues ni leurs solutions

La documentation d’[!DNL Experience Manager] couvre les cas d’utilisation standard. Pour cette raison, les bogues, leurs effets et leurs solutions ne sont généralement pas documentés.

Les exceptions à cette règle concernent les notes de mise à jour qui répertorient les problèmes connus ainsi que les solutions possibles après approbation par l’équipe de gestion des produits [!DNL Experience Manager].

Les contributions à la documentation ne sont pas destinées à répondre aux questions techniques

Toute opinion susceptible d’améliorer la documentation d’[!DNL Experience Manager] est la bienvenue sous forme de contributions. Toutefois, les commentaires, les demandes et les demandes d’extraction sont destinés uniquement aux contributions. Ils ne sont pas censés être utilisés pour répondre à vos questions sur l’utilisation d’[!DNL Experience Manager], mettre en œuvre votre projet [!DNL Experience Manager] ou résoudre des problèmes techniques.

Toute question relative à l’utilisation d’[!DNL Experience Manager] ou à la résolution d’erreurs techniques doit être soumise au moyen du processus d’assistance classique via le [!DNL Experience Manager] Portail d’assistance d’Experience Manager ou posée dans la communauté.

Les contributions à la documentation d’[!DNL Experience Manager] ne remplacent pas le service clientèle d’Adobe et toute contribution de ce type visant à obtenir des réponses à des questions d’assistance sera refusée.

Les contributions doivent clairement référencer les pages de documentation concernées.

Si vous créez une demande pour suggérer des améliorations à la documentation, vous devez inclure des liens vers les pages concernées. Si vous créez un problème à l’aide du lien Modifier cette page sur une page de documentation, le problème sera créé automatiquement avec un lien vers la page.

Cette méthode ne s’applique pas aux requêtes d’extraction qui, par nature, font référence aux pages concernées.

Directives relatives à la documentation

Nous demandons que toutes les contributions à notre documentation suivent certaines directives de style.

Suivre ces directives facilite la révision et l’intégration rapide de votre contribution dans notre documentation.

Langue et style

Langue

  • La documentation d’[!DNL Experience Manager] est créée et conservée en anglais américain.
  • Veillez à ce que les expressions restent le plus simple possible.
  • Restez clair et concis.

Gardez à l’esprit que les lecteurs de la documentation d’[!DNL Experience Manager] sont internationaux et peuvent ne pas être des locuteurs anglais natifs ou bilingues. Évitez les expressions familières et restez aussi clair et simple que possible.

Suivi du guide de style Microsoft

Le guide de style Microsoft est gratuit et concerne la documentation logicielle. Il s’applique à la documentation [!DNL Experience Manager], dans la mesure du possible.

Mise en forme

Élément Style
Élément ou option de l’interface utilisateur gras
Nom de fichier, chemin, entrée utilisateur, paramètre-valeurs monospaced
Code, ligne de commande Code Block

Captures d’écran

Les captures d’écran doivent être utilisées de manière judicieuse et uniquement lorsqu’une description textuelle est insuffisante.

Les marqueurs ou autres annotations dans les captures d’écran (comme les cadres rouges, les flèches ou le texte) ne doivent pas être utilisés. Ainsi, les captures d’écran sont plus faciles à réutiliser ou à répliquer dans les versions localisées de la documentation.

Références spécifiques à la version

Dans la mesure du possible, évitez toute référence directe à une version spécifique dans tout le contenu de la documentation. La documentation est ainsi plus flexible et extensible pour les versions ultérieures.

Utilisation de Day, [!DNL Experience Manager], CQ, CRX

Faites référence au produit par son nom complet, Adobe Experience Manager, pour la première utilisation de son nom dans un article, puis appelez-le Experience Manager.

N’utilisez pas les termes Day, Day Software, CQ et CRX, sauf lorsque c’est inévitable, comme dans les noms de classe ou en référence à l’historique d’[!DNL Experience Manager].