Authoring guidelines/en: Difference between revisions
(Importing a new version from external source) |
(Importing a new version from external source) |
||
| Line 15: | Line 15: | ||
* Is this about how to use an existing service, cluster, or application? If so, go ahead. | * Is this about how to use an existing service, cluster, or application? If so, go ahead. | ||
==Style== | == Style guidelines == | ||
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." | ||
* | * 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 === | ||
Revision as of 21:59, 19 May 2016
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 guidelines
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."
- 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
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.