Authoring guidelines/fr: Difference between revisions

Authoring guidelines/fr (view source)

Revision as of 17:19, 12 July 2016

1,183 bytes added , 8 years ago

Updating to match new version of source page

Fuzzybot

1,221

edits

@@ Line 1: / Line 1: @@
 <languages />
-== Qui peut contribuer à ce wiki? ==
+== Who can contribute to this Wiki? ==
-Tous les détenteurs d'un compte Calcul Canada. Il revient à l'équipe Calcul Canada de fournir une documentation complète et juste, mais nous sommes à l'ère Wikipédia. Si un utilisateur remarque un problème évident comme un lien brisé ou une coquille, il peut bien entendu le corriger.  Aussi, un utilisateur qui le souhaite peut rédiger un article en rapport avec un logiciel qu'il connait bien. L'équipe de documentation Calcul Canada révisera les articles affichés par les utilisateurs pour vérifier leur conformité aux présentes directives.
+Anyone with a Compute Canada account. CC staff members have the primary responsibility to keep the documentation complete and correct, but this is the age of Wikipedia. An ordinary user who spots an obvious problem, like a dead link or a typographical error, is welcome to fix it.  Equally so, a user who is willing to write an entire page on some piece of installed software with which they are very familiar, is also welcome to do that. The Compute Canada documentation team will review it once it’s posted to see that it meets these guidelines.
 La collaboration au wiki ne se fait pas de façon anonyme. Vous devez vous connecter en utilisant les coordonnées de votre compte Calcul Canada; ceci nous permet de savoir qui a rédigé ou modifié le contenu.
@@ Line 15: / Line 15: @@
 * L'information explique-t-elle comment utiliser une grappe, une application ou un service existants? Si c'est le cas, allez-y.
-==Guide de style==
+== Style guidelines ==
-Si vous doutez, imitez les maitres. Utilisez le style d'une page existante. Si vous n'en trouvez pas sur docs.computecanada.ca, cherchez sur Wikipédia.
+=== Writing style ===
-* 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.
+The purpose of a style guide is to support writers in preparing technical documentation that makes learning easier. Carefully crafted documentation appeals to the user and delivers a positive image of the writer.
-* 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''.
+There are several style guides in circulation that set standards for computer documentation. Pioneers in this area are the Apple Style Guide and the Microsoft Manual of Style.
-* 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'').
+There are no official writing guidelines for Compute Canada, but here are some simple and common practices we can readily adopt:
-* 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.
+* Design each paragraph around one idea.
+* Present the most important information first.
+* Address the reader directly.
+: Example: ''The user must click on the button'' or ''One must click on the button'' becomes ''Click on the button.''
+* Use [http://www.plainlanguage.gov/howto/wordsuggestions/simplewords.cfm simple words and phrases].
+* Use the present tense.
+: Example: ''Doing this will launch the XYZ application'' becomes ''This launches the XYZ application.''
+* Use the active voice.
+: Example: ''The file is edited by the system administrator'' becomes ''The system administrator edits the file.''
+* Stay positive.
+: Example: ''Don't use the passive voice'' becomes ''Use the active voice.''
+* Use consistent terms.
+: Yes, synonyms make a text less boring, but for a new user or one reading in a second language, interchangeable terms (e.g. "machine", "host", "node", "server") may be confusing.
+=== Layout style ===
+When in doubt, imitate the masters. Look at an existing page you like and follow the style. If there isn’t one at docs.computecanada.ca, look for one at Wikipedia.
+* Separate graphic design from content as much as possible. Don’t use extra line breaks to adjust vertical spacing. Don’t indent paragraphs with tabs or spaces or add extra spaces after a sentence. If we want to make any such style adjustments we will make them universally using stylesheets and templates.
+* Screen shots are good, especially in how-tos and tutorials. But full-sized screen shots interrupt the structure and flow of the text if they’re placed in-line. Let them float to the right-hand side. Also, scale the image down. If that makes important information unreadable, maybe a cropped picture is better? Or, remind the reader in the caption that they can "Click on the image for a larger version."
+* Leave one blank line at the end of each section before the following header. The translation package uses the blank line and header to determine the boundaries of translation units.
+* Links to other pages or sites should have a human-oriented description for display rather than the raw URL.
 === Gabarits ===