Bureaucrats, cc_docs_admin, cc_staff
2,774
edits
Authoring guidelines: Difference between revisions
Jump to navigation
Jump to search
Marked this version for translation
(mention Draft tag) |
(Marked this version for translation) |
||
| Line 20: | Line 20: | ||
== Style guidelines == <!--T:4--> | == Style guidelines == <!--T:4--> | ||
=== Drafts === | === Drafts === <!--T:12--> | ||
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 | 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> | <pre> | ||
| Line 27: | Line 27: | ||
at the top of the source. | at the top of the source. | ||
=== Writing style === | === Writing style === <!--T:13--> | ||
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. | ||
There are several style guides in circulation that set standards for computer documentation. Pioneers in this area are the Apple Style Guide and the Microsoft Manual of Style. | There are several style guides in circulation that set standards for computer documentation. Pioneers in this area are the Apple Style Guide and the Microsoft Manual of Style. | ||