Guide de rédaction

From CC Doc
Jump to navigation Jump to search
This site replaces the former Compute Canada documentation site, and is now being managed by the Digital Research Alliance of Canada.

Ce site remplace l'ancien site de documentation de Calcul Canada et est maintenant géré par l'Alliance de recherche numérique du Canada.

This page is a translated version of the page Authoring guidelines and the translation is 88% complete.
Other languages:
English • ‎français

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.

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.

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 :

  • 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 direction des communications et du marketing avant de publier.
  • S'agit-il d'un état qui change de jour en jour (disponible, hors ligne, en maintenance, etc.)? Cette information doit paraître sur https://status.computecanada.ca.
  • L'information s'adresse-t-elle aux utilisateurs et utilisatrices ou aux é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 sur la sécurité des données présentes sur nos systèmes? Si c'est le cas, communiquez avec la direction de la sécurité de l'information avant de publier.
  • L'information s'adresse-t-elle aux utilisateurs potentiels plutôt qu'aux détenteurs de compte? Il y a ici une zone grise : tout comme un utilisateur potentiel, un détenteur de compte pourrait vouloir connaître les détails techniques en rapport avec nos services et nos sites. Cependant, si l'information n'est d'intérêt que pour les utilisateurs potentiels, elle devrait se retrouver sur https://computecanada.ca plutôt que sur 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.

Si vous avez encore des doutes :

  • 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 soutien technique.

Guide de style

Dans la mesure du possible, évitez de téléverser des fichiers PDF. Copiez plutôt le texte sélectionné à partir d'un PDF et modifiez-le ensuite selon les normes du wiki en incluant par exemple les liens internes menant vers d'autres pages ou sections.

Ébauches

Si vous développez une nouvelle page et qu'elle n'est pas complète, vous devriez marquer la page comme une ébauche en insérant

{{Draft}}

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. Il existe plusieurs guides de style pour la documentation technique. L'Office québécois de la langue française en liste quelques-uns. Calcul Canada n'a pas encore de guide de style, mais il est important de retenir certaines pratiques usuelles :

  • Énoncez une idée principale par paragraphe.
  • Placez l'information en ordre d'importance.
  • Adressez-vous directement au lecteur.
Par exemple, Cliquez sur le bouton plutôt que L'utilisateur doit cliquer sur le bouton.
  • Utilisez le plus possible un vocabulaire courant et simple.
  • Construisez vos phrases avec des verbes au présent.
  • Utilisez la voix active.
Par exemple, Le fichier contient les paramètres valides plutôt que Les paramètres valides sont contenus dans le fichier.
  • Utilisez la forme positive.
Par exemple, Répondre OUI plutôt que Ne pas répondre NON.
  • 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).

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.

Autre ressource

Google Developers, Technical writing courses 1 and 2.

Mise en page

Si vous doutez, imitez les maîtres. Utilisez le style d'une page existante. Si vous n'en trouvez pas sur docs.computecanada.ca, cherchez sur Wikipédia.

  • 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.
  • 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.
  • 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.

Gabarits

Plusieurs gabarits sont disponibles. Veuillez les utiliser au besoin. Nous attirons votre attention particulièrement 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 connaître le pourcentage de la page déjà traduit ou devant être mis à jour.

Marquer une page pour la traduction

Quand vous avez terminé la rédaction d'une page, vous devez signaler qu'elle est prête à être traduite en suivant ces étapes :

  1. Le contenu à traduire doit être compris entre les balises <translate> </translate>.
  2. Utilisez aussi les balises <translate> </translate> pour délimiter le code qui ne doit pas être traduit.
  3. Les balises <translate> </translate> servent aussi à isoler le code de marquage du wiki (par exemple les tableaux et les balises).
  4. La balise <languages /> doit paraître 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.
  5. En mode View, cliquez sur Marquer cette page pour la traduction.
  6. Révisez les unités de traduction. Assurez-vous que le texte est complet et que le code de programmation et le code wiki (tableaux, balises, etc.) sont exclus des unités de traduction.
  7. Sélectionnez la langue prioritaire pour la traduction; il s'agit de la langue cible.
  8. 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. Vous ne devez jamais éditer ou copier ces codes.

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. Utilisez aussi les balises pour délimiter le code qui ne doit pas être traduit.
  3. Les balises servent aussi à isoler le code de marquage du wiki (par exemple les tableaux et les balises).
  4. 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.
  5. Révisez les unités de traduction. Assurez-vous que le texte est complet et que le code de programmation et le code wiki (tableaux, balises, etc.) sont exclus des unités de traduction.
  6. Vérifiez que la langue prioritaire est sélectionnée; il s'agit de la langue cible.
  7. Cliquez sur Marquer cette page pour la traduction.

Code blocks are not translated

Our professional human translator is not a programmer. They cannot distinguish between code and comments in every possible language, so the documentation team has instructed the translator to exclude code blocks from translation.

Putting explanatory comments in code is excellent programming practice which we wish to encourage, but the value of the comments is decreased if the comments aren't translated. The documentation team has not found a solution for this that works in every case. Here are some suggestions:

  1. Move the information contained in the comments outside the code block, into the surrounding text (which will then be translated).
  2. Leave an index comment (e.g. "NOTE 1", "NOTE 2") to connect the external text to the relevant line of code.
  3. If you're sufficiently bilingual, and familiar with the translation apparatus, you may translate the code block yourself.

Please do not leave example code uncommented, but please do remember that comments will not normally be translated, and consider how this will affect the understanding of the user reading the page in translation.

Page des logiciels disponibles

Les tableaux de la page wiki 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 personnel de Calcul Canada membre du projet Git.

Les ajouts sont affichés six heures après la modification.