39,881
edits
Authoring guidelines/en: 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 14: | Line 14: | ||
* External links may be appropriate, see e.g. "Getting an Account". | * 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. | * Is this about how to use an existing service, cluster, or application? If so, go ahead. | ||
If you still have any doubt, Compute Canada staff members should use the #rsnt-documentation channel in Slack. Non-staff contributors should write to [mailto:support@computecanada.ca support@computecanada.ca]. | |||
== Style guidelines == | == Style guidelines == | ||
=== Drafts === | |||
If you wish to work on a new page in stages, or get feedback before deciding it is complete, you should mark the page as a draft by inserting | |||
<pre> | |||
{{Draft}} | |||
</pre> | |||
at the top of the source. | |||
=== Writing style === | === Writing style === | ||
The purpose of a style guide is to support writers in preparing technical documentation that makes learning easier. Carefully crafted documentation appeals to the user and delivers a positive image of the writer. | The purpose of a style guide is to support writers in preparing technical documentation that makes learning easier. Carefully crafted documentation appeals to the user and delivers a positive image of the writer. | ||