Guide de rédaction
Tous les composants disponibles pour rédiger la documentation Fullmetrix, avec les conventions à suivre.
Cette page liste tout ce que vous pouvez utiliser dans une page de documentation. Chaque exemple montre le rendu, et la source est le fichier que vous lisez : content/docs/fr/writing-guide.mdx.
Organisation des fichiers
Chaque langue a son dossier. Une page absente en français retombe sur la version anglaise : écrivez d'abord l'anglais, puis traduisez, en gardant le même nom de fichier.
En-tête de page
Propriété
Type
Encadrés
Une note simple.
Information
Un contexte utile au lecteur.
Réussite
Tout s'est passé comme prévu.
Attention
Quelque chose peut mal tourner.
Erreur
Quelque chose va casser.
Astuce
Un raccourci ou une bonne habitude.
Étapes
Première étape
Expliquez quoi faire et pourquoi.
Deuxième étape
Renvoyez vers d'autres pages avec des liens.
Onglets
Contenu pour Shopify. Le choix est mémorisé d'une page à l'autre.
Blocs de code
const revenue = orders.reduce((total, order) => total + order.total, 0) npm install fullmetrixAccordéon
Conventions
- Phrases courtes, mots simples.
- Jamais d'émojis, de tirets cadratins ni de demi-cadratins comme séparateurs.
- Accents français corrects.
- Ne décrivez pas une fonction que vous n'avez pas vérifiée dans le produit.
- Noms de fichiers en kebab-case, identiques dans les deux langues.
- Une page qui affiche encore l'encadré "Bientôt disponible" est une page vide. Remplacez tout le corps, et gardez le titre et la description exacts.
- Chaque page existe dans les deux langues avec le même nom de fichier. Écrivez l'anglais d'abord, puis traduisez.
- Dans chaque dossier,
meta.jsonfixe l'ordre du menu. Un dossier utilise son propreindex.mdxcomme page d'accueil : ne listez pasindexdanspages. Une ligne---Titre---ajoute un titre de section.