Authoring guidelines/en: Difference between revisions

From Alliance Doc
Jump to navigation Jump to search
(Importing a new version from external source)
(Importing a new version from external source)
Line 5: Line 5:
No anonymous editing is possible. You must log in with your Compute Canada credentials before you are allowed to edit, so we can tell who has done what.
No anonymous editing is possible. You must log in with your Compute Canada credentials before you are allowed to edit, so we can tell who has done what.


==Quel type d'information publier sur ce wiki?==
== What belongs on this Wiki? ==
Ce wiki n'est pas l'endroit où publier l'information qui relève de la compétence de l'équipe de direction de Calcul Canada et particulièrement de celle de la directrice administrative des affaires extérieures (ci-après, la Directrice). Est donc exclue toute information destinée au public, aux médias et aux agences de financement. Ce wiki se veut un lieu de documentation technique; le matériel de formation ou de publicité n'y a pas sa place. Avant de publier ou de modifier une page, posez-vous les questions suivantes&nbsp:
This Wiki is not the place for information which properly belongs in the purview of the Compute Canada executive team, particularly the Executive Director of External Affairs (henceforth called the Executive). This obviously includes any communications intended for the general public, media or funding agencies. Materials related to training and outreach also don’t belong on this technical documentation site. To that end, ask yourself before you publish a page or make a change:
*&nbspL'information est-elle en rapport avec les services ou les équipements offerts par l'organisation? Si c'est le cas, cette information est-elle publiquement disponible? Pour les autres cas, consultez la Directrice avant publication.
* Is this about what services or clusters are available? If so, has the service or cluster already been announced? If not, consult the Executive before publishing.  
*&nbspS'il s'agit de renseignements en rapport avec l'état d'un équipement sujet à changer à très court terme (par exemple ''disponible'', ''hors réseau'', ''en réparation''), la responsabilité en revient probablement à l'équipe de surveillance.
* Status information which changes on short notice --- available, offline, in maintenance, etc.--- will likely be the responsibility of the Monitoring Team.
*&nbspL'information s'adresse-t-elle aux utilisateurs plutôt qu'à une équipe technique de Calcul Canada? Si elle est destinée à une équipe technique, elle devrait se trouver sur ''https://ccdb.computecanada.ca/wiki/'' plutôt qu'ici.
* Is this information useful to a user, as opposed to other CC technical staff? If technical staff, then it might belong at https://ccdb.computecanada.ca/wiki/ rather than https://docs.computecanada.ca/wiki/.
*&nbspL'information a-t-elle un lien quelconque avec la sécurité de nos données ou de nos systèmes? Si c'est le cas, consultez le directeur de la sécurité de l'information avant publication.
* Does the information have implications for the security of our systems, or data on our systems? If so, consult the Director of Information Security before publishing.
*L'information est-elle destinée à un type d'utilisateur particulier? Il y a ici une zone grise&nbsp: tout comme les détenteurs de comptes en bonne et due forme, les utilisateurs potentiels ont parfois besoin de renseignements sur nos services et nos installations. Si l'information s'adresse à un utilisateur potentiel, elle doit être publiée sur ''https://computecanada.ca'' plutôt qu'ici.
* Is the information of interest only to a prospective user, as opposed to an existing account-holder? This is a gray area: A prospective user might want to know technical details about our services and facilities, the same as an account-holder, but if the information is only of interest to a prospective user then it properly belongs on https://computecanada.ca rather than https://docs.computecanada.ca/wiki/.  
**&nbspIl est parfois indiqué d'inclure un hyperlien (par exemple, Voir&lsquoObtenir un compte&rsquo).
** External links may be appropriate, see e.g. "Getting an Account".
*&nbspLes renseignements décrivent-ils comment utiliser un service, une grappe ou une application? Si oui, vous êtes au bon endroit.
* Is this about how to use an existing service, cluster, or application? If so, go ahead.


==Style==
==Style==

Revision as of 21:57, 19 May 2016

Other languages:

Who can contribute to this Wiki?

Anyone with a Compute Canada account. CC staff has the primary responsibility to keep the documentation complete and correct, but this is the age of Wikipedia. If a user spots an obvious problem, like a dead link or a typographical error, they are welcome to fix it. If you have a user who is willing to write an entire page, for example, on some piece of installed software with which they are more familiar than you are, they are also welcome to do that. We’ll review it once it’s posted to see that it meets these guidelines.

No anonymous editing is possible. You must log in with your Compute Canada credentials before you are allowed to edit, so we can tell who has done what.

What belongs on this Wiki?

This Wiki is not the place for information which properly belongs in the purview of the Compute Canada executive team, particularly the Executive Director of External Affairs (henceforth called the Executive). This obviously includes any communications intended for the general public, media or funding agencies. Materials related to training and outreach also don’t belong on this technical documentation site. To that end, ask yourself before you publish a page or make a change:

  • Is this about what services or clusters are available? If so, has the service or cluster already been announced? If not, consult the Executive before publishing.
  • Status information which changes on short notice --- available, offline, in maintenance, etc.--- will likely be the responsibility of the Monitoring Team.
  • Is this information useful to a user, as opposed to other CC technical staff? If technical staff, then it might belong at https://ccdb.computecanada.ca/wiki/ rather than https://docs.computecanada.ca/wiki/.
  • Does the information have implications for the security of our systems, or data on our systems? If so, consult the Director of Information Security before publishing.
  • Is the information of interest only to a prospective user, as opposed to an existing account-holder? This is a gray area: A prospective user might want to know technical details about our services and facilities, the same as an account-holder, but if the information is only of interest to a prospective user then it properly belongs on https://computecanada.ca rather than https://docs.computecanada.ca/wiki/.
    • External links may be appropriate, see e.g. "Getting an Account".
  • Is this about how to use an existing service, cluster, or application? If so, go ahead.

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, cherchez sur Wikipédia dans son ensemble.

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

Templates

There are multiple templates, available. Please use them as appropriate. Of particular interests are templates for Including a command within the wiki and for Including a source code file within the wiki.

Traduction

Retrieved from "https://docs.alliancecan.ca/mediawiki/index.php?title=Authoring_guidelines/en&oldid=1306"