cc_staff
318
edits
Authoring guidelines/fr: Difference between revisions
no edit summary
m (FuzzyBot moved page Authoring Guidelines/fr to Authoring guidelines/fr without leaving a redirect: Part of translatable page "Authoring Guidelines".) |
No edit summary |
||
| Line 19: | Line 19: | ||
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: | ||
* Énoncer une idée principale par paragraphe. | * Énoncer une idée principale par paragraphe. | ||
* Placer l'information en ordre d'importance. | * Placer l'information en ordre d'importance. | ||
* Adressez-vous directement au lecteur. | * Adressez-vous directement au lecteur. | ||
: 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: 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: 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'', ''noeud'', ''serveur''). | |||
=== Mise en page === | === Mise en page === | ||
Si vous doutez, imitez les maitres. Utilisez le style d'une page existante. Si vous n'en trouvez pas sur [http://docs.computecanada.ca docs.computecanada.ca], cherchez sur [http://www.wikipedia.org Wikipédia]. | Si vous doutez, imitez les maitres. Utilisez le style d'une page existante. Si vous n'en trouvez pas sur [http://docs.computecanada.ca docs.computecanada.ca], cherchez sur [http://www.wikipedia.org Wikipédia]. | ||