rsnt_translations
54,003
edits
Authoring guidelines/fr: Difference between revisions
Jump to navigation
Jump to search
no edit summary
No edit summary |
No edit summary |
||
| Line 30: | Line 30: | ||
Le guide de style aide les rédacteurs à produire une documentation technique qui facilite l'apprentissage. Une documentation bien préparée est agréable au lecteur et projette une image positive de l'auteur. | Le guide de style aide les rédacteurs à produire une documentation technique qui facilite l'apprentissage. Une documentation bien préparée est agréable au lecteur et projette une image positive de l'auteur. | ||
Il existe plusieurs guides de style pour la documentation technique. L'Office québécois de la langue française en liste quelques-uns. | Il existe plusieurs guides de style pour la documentation technique. L'Office québécois de la langue française en liste quelques-uns. | ||
Calcul Canada n'a pas encore de guide de style, mais il est important de retenir certaines pratiques usuelles: | Calcul Canada n'a pas encore de guide de style, mais il est important de retenir certaines pratiques usuelles : | ||
* | * Énoncez une idée principale par paragraphe. | ||
* | * Placez l'information en ordre d'importance. | ||
* Adressez-vous directement au lecteur. | * Adressez-vous directement au lecteur. | ||
: Par exemple | : Par exemple, ''Cliquez sur le bouton'' plutôt que ''L'utilisateur doit cliquer sur le bouton''. | ||
* Utilisez le plus possible un vocabulaire courant et simple. | * Utilisez le plus possible un vocabulaire courant et simple. | ||
* Construisez vos phrases avec des verbes au présent. | * Construisez vos phrases avec des verbes au présent. | ||
* Utilisez la voix active. | * Utilisez la voix active. | ||
: Par exemple | : Par exemple, ''Le fichier contient les paramètres valides'' plutôt que ''Les paramètres valides sont contenus dans le fichier''. | ||
* Utilisez la forme positive. | * Utilisez la forme positive. | ||
: Par exemple | : Par exemple, ''Répondre OUI plutôt que ''Ne pas répondre NON''. | ||
* Employez le mot juste. | * Employez le mot juste. | ||
: Bien sûr, les synonymes rendent le texte moins ennuyant, mais ils peuvent créer de la confusion chez un nouvel utilisateur ou un utilisateur dont la langue maternelle est différente de celle du texte (par exemple, ''machine'', ''hôte'', ''nœud'', ''serveur''). | : Bien sûr, les synonymes rendent le texte moins ennuyant, mais ils peuvent créer de la confusion chez un nouvel utilisateur ou un utilisateur dont la langue maternelle est différente de celle du texte (par exemple, ''machine'', ''hôte'', ''nœud'', ''serveur''). | ||