38,760
edits
Authoring guidelines/fr: Difference between revisions
Jump to navigation
Jump to search
Updating to match new version of source page
(Updating to match new version of source page) |
(Updating to match new version of source page) |
||
| Line 1: | Line 1: | ||
<languages /> | <languages /> | ||
<div class="mw-translate-fuzzy"> | |||
== Qui peut contribuer à ce wiki? == | == Qui peut contribuer à ce wiki? == | ||
Si vous avez un compte avec Calcul Canada, vous pouvez contribuer. Une des tâches de notre équipe est de fournir une documentation complète et juste, mais nous sommes à l'ère Wikipédia. Si vous remarquez un problème évident comme un lien brisé ou une coquille, vous pouvez bien entendu le corriger. Si vous le souhaitez, vous pouvez aussi rédiger un article en rapport avec un logiciel que vous connaissez bien. Notre équipe de documentation révise les articles rédigés pour vérifier leur conformité aux présentes directives. | Si vous avez un compte avec Calcul Canada, vous pouvez contribuer. Une des tâches de notre équipe est de fournir une documentation complète et juste, mais nous sommes à l'ère Wikipédia. Si vous remarquez un problème évident comme un lien brisé ou une coquille, vous pouvez bien entendu le corriger. Si vous le souhaitez, vous pouvez aussi rédiger un article en rapport avec un logiciel que vous connaissez bien. Notre équipe de documentation révise les articles rédigés pour vérifier leur conformité aux présentes directives. | ||
</div> | |||
<div class="mw-translate-fuzzy"> | |||
La collaboration au wiki ne se fait pas de façon anonyme. Vous devez vous connecter en utilisant les informations d'identification pour votre compte; ceci nous permet de savoir qui a rédigé ou modifié le contenu. | La collaboration au wiki ne se fait pas de façon anonyme. Vous devez vous connecter en utilisant les informations d'identification pour votre compte; ceci nous permet de savoir qui a rédigé ou modifié le contenu. | ||
</div> | |||
<div class="mw-translate-fuzzy"> | |||
== Contenu du wiki == | == Contenu du wiki == | ||
Ce wiki n'est pas l'endroit où afficher l'information qui relève de la responsabilité de la direction des communications et du marketing, ce qui inclut toute information pour communication au grand public, aux médias et aux agences de financement. Aussi, l'information touchant les activités de formation et de rayonnement ne convient pas au contenu de la documentation technique. Avant de publier une page ou de modifier le contenu du wiki, posez-vous les questions suivantes : | Ce wiki n'est pas l'endroit où afficher l'information qui relève de la responsabilité de la direction des communications et du marketing, ce qui inclut toute information pour communication au grand public, aux médias et aux agences de financement. Aussi, l'information touchant les activités de formation et de rayonnement ne convient pas au contenu de la documentation technique. Avant de publier une page ou de modifier le contenu du wiki, posez-vous les questions suivantes : | ||
| Line 17: | Line 22: | ||
* si vous êtes à l'emploi de Calcul Canada, utilisez le canal #rsnt-documentation dans Slack; | * si vous êtes à l'emploi de Calcul Canada, utilisez le canal #rsnt-documentation dans Slack; | ||
* si vous n'êtes pas à l'emploi de Calcul Canada, communiquez avec le [[Technical support/fr|soutien technique]]. | * si vous n'êtes pas à l'emploi de Calcul Canada, communiquez avec le [[Technical support/fr|soutien technique]]. | ||
</div> | |||
==Guide de style== | ==Guide de style== | ||
| Line 27: | Line 33: | ||
</pre> | </pre> | ||
<div class="mw-translate-fuzzy"> | |||
=== Rédaction === | === 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. | 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. | ||
| Line 43: | Line 50: | ||
* Employez le mot juste. | * 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'', ''nœud'', ''serveur''). | : 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''). | ||
</div> | |||
<div class="mw-translate-fuzzy"> | |||
Le terme ''système'' est souvent employé de façon générique : il peut désigner entre autres un ordinateur, une grappe ou encore un environnement ou un logiciel. Veillez à utiliser le mot juste pour éviter toute confusion. | Le terme ''système'' est souvent employé de façon générique : il peut désigner entre autres un ordinateur, une grappe ou encore un environnement ou un logiciel. Veillez à utiliser le mot juste pour éviter toute confusion. | ||
</div> | |||
==== Autre ressource ==== | ==== Autre ressource ==== | ||
| Line 50: | Line 60: | ||
Google Developers, ''[https://developers.google.com/tech-writing/overview Technical writing courses 1 and 2]''. | Google Developers, ''[https://developers.google.com/tech-writing/overview Technical writing courses 1 and 2]''. | ||
<div class="mw-translate-fuzzy"> | |||
=== Mise en page === | === Mise en page === | ||
Si vous doutez, imitez les maîtres. 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]. | Si vous doutez, imitez les maîtres. 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]. | ||
| Line 56: | Line 67: | ||
* 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''). | * 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. | * 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> | |||
=== Gabarits === | === Gabarits === | ||
| Line 109: | Line 121: | ||
= Page des logiciels disponibles = | = Page des logiciels disponibles = | ||
Les tableaux de la page wiki [[Available software/fr|Logiciels disponibles]] sont générés à partir de fichiers de modules dans CVMFS. Pour ajouter un lien vers une nouvelle page dans la colonne ''Documentation'', faites une entrée dans https://git.computecanada.ca/rsnt-software/wiki_module_bot/blob/master/module_wiki_page.json. Ce répertoire peut être modifié par le [https://git.computecanada.ca/rsnt-software/wiki_module_bot/-/project_members personnel de Calcul Canada membre du projet Git]. | <div class="mw-translate-fuzzy"> | ||
Les tableaux de la page wiki [[Available software/fr|Logiciels disponibles]] sont générés à partir de fichiers de modules dans CVMFS. Pour ajouter un lien vers une nouvelle page dans la colonne ''Documentation'', faites une entrée dans https://git.computecanada.ca/rsnt-software/wiki_module_bot/blob/master/module_wiki_page.json. Ce répertoire peut être modifié par le [https://git.computecanada.ca/rsnt-software/wiki_module_bot/-/project_members personnel de Calcul Canada membre du projet Git]. | |||
</div> | |||
Les ajouts sont affichés six heures après la modification. | Les ajouts sont affichés six heures après la modification. | ||
</translate> | </translate> | ||