Authoring guidelines/fr

Qui peut contribuer à ce 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.

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.

Contenu du wiki

Ce wiki n'est pas l'endroit où afficher l'information qui relève de la responsabilité de la direction de Calcul Canada, particulièrement de la responsabilité de la directrice générale des Affaires extérieures (ci-après la directrice). Ceci inclut toute information pour communication au grand public, aux médias et aux agences de financement. L'information touchant les activités de formation et de rayonnement ne conviennent pas au contenu de ce wiki pour la documentation technique. Avant de publier une page ou de modifier le contenu du wiki, posez-vous les questions suivantes :

• Cette information est-elle au sujet de la disponibilité d'une grappe ou d'un service? Si c'est le cas, cette grappe ou ce service a-t-il fait l'objet d'une annonce? Autrement, communiquez avec la directrice avant de publier.
• L'information sur un état susceptible de changer à court terme (disponible, hors ligne, en maintenance, etc.) est probablement sous la responsabilité de l'équipe de suivi.
• L'information s'adresse-t-elle aux utilisateurs ou à d'autres membres des équipes techniques de Calcul Canada? Si elle s'adresse à une équipe technique, elle devrait se trouver sur https://wiki.computecanada.ca/staff/ plutôt que sur https://docs.computecanada.ca/wiki/.
• Cette information a-t-elle une incidence sur la sécurité de nos systèmes ou des données sur nos systèmes? Si c'est le cas, communiquez avec le directeur de la sécurité de l'information avant de publier.
• L'information s'adresse-t-elle à un utilisateur potentiel plutôt qu'à un détenteur de compte? Il y a ici une zone grise : un utilisateur potentiel pourrait vouloir connaitre les détails techniques en rapport avec nos services et nos sites, tout comme un détenteur de compte. Cependant, si l'information n'est d'intérêt que pour un utilisateur potentiel, elle devrait se retrouver sur https://computecanada.ca plutôt que dans https://docs.computecanada.ca/wiki/.
• Il est approprié de publier des liens externes; voir par exemple Obtenir un compte.
• L'information explique-t-elle comment utiliser une grappe, une application ou un service existants? Si c'est le cas, allez-y.

Style guidelines

Writing style

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. 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. There are no official writing guidelines for Compute Canada, but here are some simple and common practices we can readily adopt:

• 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 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.
• Capitalize only the first word and proper nouns in titles and headings. Following Wikipedia, we prefer APA sentence case for all titles, including page titles.

Gabarits

Plusieurs gabarits sont disponibles. Veuillez les utiliser au besoin. Nous attirons votre attention sur les gabarits pour Inclure une commande dans une page wiki et Inclure un fichier de code source dans une page wiki.

Traduction

La page dans la langue source doit être marquée pour la traduction. Toute personne peut traduire une page marquée pour traduction avec les outils de l'extension wiki Traduire. Vous trouverez un tutoriel ici. Une page traduite peut ensuite être révisée.

Lorsqu'une page est marquée pour la traduction, l'extension Traduire analyse son contenu et le divise en unités de traduction qui sont par exemple un titre, un paragraphe, une image ou autre. Les unités discrètes sont traduites individuellement : ainsi, une modification à une unité n'a pas d'effet sur le reste de la page et il est possible de connaitre le pourcentage de la page déjà traduit ou devant être mis à jour.

Marquer une page pour la traduction

1. Le contenu à traduire doit être compris entre les codes <translate> </translate>.
2. Le code <languages /> doit paraitre au tout début de la page. Ceci affichera une boîte au haut de la page contenant la liste des langages disponibles pour la page.
3. En mode View, cliquez sur Marquer cette page pour la traduction.
4. Effectuez la traduction des unités en évitant de modifier les codes wiki.
5. Sélectionnez la langue prioritaire pour la traduction; il s'agit de la langue cible.
6. Cliquez sur Marquer cette page pour la traduction.

Identifier les modifications dans une page marquée pour la traduction

Il est recommandé de marquer une page pour la traduction une fois que le contenu en langue source est stable. Si une page déjà traduite ne comporte pas de changements, évitez de modifier les codes tels que <!--T:3-->, qui sont des codes générés automatiquement.

Une fois la page corrigée, marquez les modifications à traduire comme suit :

1. Le nouveau contenu à traduire doit être compris entre les codes <translate> </translate>.
2. En mode View, un message au haut de la page vous informe que la page comporte des modifications faites après qu'elle ait été marquée pour la traduction.
3. Effectuez la traduction des unités en évitant de modifier les codes wiki.
4. Sélectionnez la langue prioritaire pour la traduction; il s'agit de la langue cible.
5. Cliquez sur Marquer cette page pour la traduction.