Authoring guidelines/en: Difference between revisions

Jump to navigation Jump to search

Authoring guidelines/en (view source)

Revision as of 19:48, 8 April 2016

592 bytes removed ,  8 years ago
Created page with "==Style== 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, cherc..."
No edit summary
(Created page with "==Style== 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, cherc...")
Line 15: Line 15:
*&nbspLes renseignements décrivent-ils comment utiliser un service, une grappe ou une application? Si oui, vous êtes au bon endroit.
*&nbspLes renseignements décrivent-ils comment utiliser un service, une grappe ou une application? Si oui, vous êtes au bon endroit.


== Style guidelines ==
==Style==
If 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.
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.
* 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.
*&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.
* 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."
*&nbspAjoutez des captures d'écran, particulièrement dans les tutoriels et pour expliquer des procédures. Totuefois, une image plein écran placée à même le texte crée un bris dans la structure et le rythme.
* 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.
* 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 ===
Diane27
rsnt_translations
56,430

edits

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

Navigation menu