Authoring guidelines/en: Difference between revisions

Jump to navigation Jump to search

Authoring guidelines/en (view source)

Revision as of 21:59, 19 May 2016

150 bytes removed ,  8 years ago
Importing a new version from external source
(Importing a new version from external source)
(Importing a new version from external source)
Line 15: Line 15:
* Is this about how to use an existing service, cluster, or application? If so, go ahead.
* Is this about how to use an existing service, cluster, or application? If so, go ahead.


==Style==
== Style guidelines ==
En cas de doute, imitez les maitres. Trouvez une page que vous aimez et appliquez les mêmes effets de style. Si vous ne trouvez pas sur docs.computecanada.ca, cherchez sur Wikipédia dans son ensemble.
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.
*&nbspIsolez le contenu graphique du texte autant que possible. Évitez d'insérer des sauts de ligne pour ajuster l'espacement vertical. N'utilisez pas des espaces ou des tabulations à la fin des phrases. Il est préférable d'utiliser une feuille de styles ou un gabarit.
* 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.
*&nbspAjoutez des captures d'écran, particulièrement dans les tutoriels et pour expliquer des procédures. Toutefois, une image plein écran placée à même le texte crée un bris dans la structure et le rythme. Placez donc les images à la marge de droite et diminuez leur taille. Si une dimension acceptable ne permet pas de voir certains éléments importants, peut-être serait-il préférable de rogner l'image (crop), ou d'inviter le lecteur à "Cliquer pour agrandir".
* 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."
*&nbspNe variez pas les synonymes. S'ils rendent le texte moins ennuyant, ils créent souvent de la confusion chez les nouveaux utilisateurs ou ceux qui connaissanent moins la langue; par exemple, l'emploi sans distinction de ''machine'', ''hôte'', ''n&oeligud'', ''serveur'' peut nuire à la compréhension.
* Minimize use of synonyms. Yes, it makes the 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.
*&nbspFaites un saut de ligne entre la fin d'une section et le titre de la section suivante : c'est ainsi que la fonction de traduction délimite les unités lexicales.
* 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.


=== Templates ===
=== Templates ===
Fuzzybot
1,221

edits

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

Navigation menu