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 27: | Line 27: | ||
</pre> | </pre> | ||
=== Rédaction === | === Rédaction === | ||
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. | ||
Aucun guide de style n'existe pour notre wiki, mais il est important de retenir certaines pratiques usuelles : | |||
* Énoncez une idée principale par paragraphe. | * Énoncez une idée principale par paragraphe. | ||
* Placez l'information en ordre d'importance. | * Placez l'information en ordre d'importance. | ||
| Line 44: | Line 43: | ||
* 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''). | ||
<div class="mw-translate-fuzzy"> | <div class="mw-translate-fuzzy"> | ||