Normes de rédaction d'articles et modèle

Ce modèle décrit les normes pour la rédaction d'articles bien informés. Utilisez les articles de la base de connaissances d'Apple comme exemple : https://support.apple.com/en-ca/HT207935

Titre

Le titre de l'article doit refléter le contenu de l'article pour une reconnaissance facile et pour faciliter la recherche.

Exemples : « Comment supprimer une chanson ? », « Bienvenue sur Anytune iPhone/iPad »

Des lignes directrices

1. Évitez de créer des articles en double. Recherchez attentivement avant de créer.
2. Commencez par "Titre 2" pour les titres. Le titre de l'article est Heading 1 et il ne devrait y en avoir qu'un.
3. Mettez en majuscule les noms de produits et les noms de boutons de texte :
   Appuyez sur le bouton Modifier. Ne pas mettre les commandes en gras.
4. Utilisez l'image du tableau du bouton (svg) d'une taille de 22 pixels de haut lorsque le bouton utilise une icône :
   Appuyez sur Restaurer
5. Utilisez des guillemets pour sélectionner les options :
   3. Choisissez "Tuned Song" et "Email"
6. Pour suivre une hiérarchie, utilisez :
   Allez dans Anytune Menu > Fichiers > Config Exporter > Exporter vers un fichier...
7. Utilisez des listes numérotées pour les étapes d'une procédure.
   Les étapes se terminent par une période.
8. Les titres des procédures sont H@ et se terminent par deux points. Exemple : « Titre de la procédure : »
9. Lorsque les étapes sont différentes pour les versions du produit, créez plusieurs sections avec un titre de description à 3 titres
10. Utilisez des puces pour les listes.
11. Maintenir le contexte du client
12. Souvenez-vous du public
13. Ne pas référencer un client
14. S'abstenir d'abréviations et d'acronymes
15. Assurez-vous que tous les liens fonctionnent

Étiquettes

Incluez des étiquettes appropriées avec les articles. Les étiquettes influencent la pertinence de la recherche d'articles et les résultats des robots de réponse. Ils peuvent également être utilisés pour créer des listes d'articles.

Utilisez un seul mot dans la mesure du possible et n'utilisez pas de variantes du même mot. Utilisez les étiquettes avec parcimonie.
Exemples : macOS, importation, bluetooth, ReFrame

Modèle

---

---

Résumé de ce que cet article vous dira.

Utiliser la rubrique 3 pour le processus et pour distinguer les plateformes

1. Étapes du processus
2. Appuyez sur le Bouton d'aide
3. Choisissez "E-mail"
4. Appuyez sur Modifier

Sur Mac, le processus est

Remarque : Fournissez des notes dans <p class="anytune-note">note</p>

Avertissement : Fournissez des notes dans <p class="anytune-warning">note</p>

Soulignez en mettant en évidence avec <p class="anytune-highlight">note</p>

En savoir plus (H3)

Dites à l'utilisateur où se trouvent plus d'informations par des liens .

---

---

Comment corriger les problèmes

Lorsque l'article décrit comment résoudre un problème, incluez ces sections

• Problème : Décrivez le problème et essayez d'utiliser les mots du client.
• Environnement : décrivez la configuration et la configuration auxquelles ce correctif s'applique (facultatif)
• Résolution : ce sont les étapes pour résoudre
• Cause : quel scénario a causé ou peut avoir causé le problème
• Libellés : incluez des mots qui se rapportent à l'article en question pour vous aider

Voir également

• Mise en forme des articles