Bureaucrats, cc_docs_admin, cc_staff
2,774
edits
Authoring guidelines: Difference between revisions
Jump to navigation
Jump to search
beware of "system"
No edit summary |
(beware of "system") |
||
| Line 44: | Line 44: | ||
* Use consistent terms. | * 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. | : 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. | ||
The word "system" is used frequently in computing with different meanings (legacy system, new system, WestGrid system, cloud system, file system, module system, job scheduling system, GPU system, storage system, ''etc.''). It is not always clear to a new user what we are talking about. Whenever possible, please try to use a more precise word (cluster, storage space, scheduler, ''etc.''). | |||
=== Layout style === | === 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 [http://docs.computecanada.ca docs.computecanada.ca], look for one at [[wikipedia: | Wikipedia]]. | When in doubt, imitate the masters. Look at an existing page you like and follow the style. If there isn’t one at [http://docs.computecanada.ca docs.computecanada.ca], look for one at [[wikipedia: | Wikipedia]]. | ||