Authoring guidelines/fr: Difference between revisions

Jump to navigation Jump to search

Authoring guidelines/fr (view source)

Revision as of 14:34, 7 December 2016

2,940 bytes removed ,  7 years ago
Replaced content with "==Guide de style=="
No edit summary
(Replaced content with "==Guide de style==")
Line 18: Line 18:
* si vous n'êtes pas employé par Calcul Canada, veuillez écrire à [mailto:support@calculcanada.ca support@calculcanada.ca]
* si vous n'êtes pas employé par Calcul Canada, veuillez écrire à [mailto:support@calculcanada.ca support@calculcanada.ca]


<div class="mw-translate-fuzzy">
==Guide de style==
==Guide de style==  
=== 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.
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:
* Énoncer une idée principale par paragraphe.
* Placer l'information en ordre d'importance.
* 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.
* Construisez vos phrases avec des verbes au présent.
* 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.
: Par exemple: Répondre OUI plutôt que Ne pas répondre NON.
* 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 ===
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]. 
* Autant que possible, gardez les images à part du contenu texte. N'utilisez pas des sauts de ligne pour ajuster l'espacement vertical. N'utilisez pas la tabulation ou des espaces pour mettre un paragraphe en retrait; n'ajoutez pas d'espace à la fin d'une phrase. Si ce type de formatage est souhaitable, nous préparerons des feuilles de style ou des gabarits, le cas échéant.
* Les captures d'écran sont utiles, surtout dans le cas de guides d'utilisation ou de tutoriels. Cependant, les captures plein écran incluses dans le texte nuisent à la lisibilité. Placez les images flottantes à la droite du texte. Réduisez aussi la taille de l'image. Si la visibilité n'est pas acceptable, peut-être devriez-vous rogner l'image? Vous pouvez aussi ajouter la mention ''Cliquez pour agrandir''.
* Employez le moins de synonymes possible. 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'').
* Laissez une ligne vide à la fin d'une section, avant le titre de la prochaine section. La fonction de traduction utilise la ligne vide et le titre pour délimiter les unités de traduction.
</div>


=== Drafts ===
=== Drafts ===
Mboisson
Bureaucrats, cc_docs_admin, cc_staff, rsnt_translations
2,837

edits

Retrieved from "https://docs.alliancecan.ca/wiki/Special:MobileDiff/6093"

Navigation menu