Liste de vérification pour l'écriture
Utilisez cette liste de vérification pour communiquer de manière claire, utile et cohérente avec le reste de la documentation Docker.
Utilisé la voix active
La voix active est spécifique et élimine l'ambiguïté.
Dans la voix active, le sujet de la phrase (le client ou le système) effectue l'action.
Les phrases qui utilisent la voix active sont plus faciles à lire. La voix active indique clairement qui a fait quoi et à qui. De plus, la voix active maintient les phrases directes et plus concises.
Les verbes auxiliaires tels que est, était, ou serait peuvent indiquer que vous écrivez à la voix passive. Et, si vous pouvez ajouter la phrase 'par des zombies' après le verbe, vous écrivez à la voix passive.
| Correct | Incorrect |
|---|---|
| Augmentez la productivité avec Docker Desktop. | La productivité peut être augmentée (par des zombies) avec Docker Desktop. |
| Si vous supprimez des éléments d'une grille, les graphiques se rafraîchissent automatiquement pour afficher le changement. | Si des éléments sont supprimés (par des zombies) d'une grille, les graphiques se rafraîchissent automatiquement pour afficher le changement. |
Écrit des phrases claires qui vont droit au but
Écrivez des phrases courtes et concises. Les phrases percutantes sont plus rapides à lire et plus faciles à comprendre.
Utilisé des sous-titres et des listes à puces pour structurer la page
Cela aide à trouver l'information dont ils ont besoin rapidement et facilement.
Pour plus d'informations, consultez la page formatage, ou consultez les composants pour des exemples.
Commencé le titre de votre page par un verbe
Par exemple, 'Installer Docker Desktop'.
Vérifié que le titre de la table des matières de gauche dans docs.docker.com, correspond au titre affiché sur la page
Vérifié les liens brisés et les images
Utilisez des liens relatifs pour lier vers d'autres pages ou images dans le dépôt GitHub.
Pour plus d'informations, consultez la page formatage, ou consultez les composants pour des exemples.
Vérifié que toutes les redirections que vous avez pu ajouter, fonctionnent
Pour des informations sur comment ajouter des redirections, consultez Conventions des fichiers sources.
Utilisé le gras pour tous les éléments d'interface utilisateur auxquels vous vous référez dans votre contenu
Effectué une vérification finale de l'orthographe, de la ponctuation et de la grammaire
Pour des informations plus approfondies sur notre Guide de Style, explorez les guides de grammaire ou de formatage.