Difference between revisions of "Wiki.emacinc.com:Style Guide"
(added outline and intro) |
m (minor changes) |
||
| Line 1: | Line 1: | ||
This page serves as a set of guidelines for style, formatting, and content across the EMAC Wiki project. While there will be exceptions, following the standards set here will promote consistency and best-practices across the wiki and provide a reference for content review. This guide should be treated as a living document and updated with the current conventions. | This page serves as a set of guidelines for style, formatting, and content across the EMAC Wiki project. While there will be exceptions, following the standards set here will promote consistency and best-practices across the wiki and provide a reference for content review. This guide should be treated as a living document and updated with the current conventions. | ||
| − | == | + | == Writing Style == |
| + | While not completely formal, this wiki is a collection of professional technical documents and should be written as such. Advertising rhetoric, colloquialism, and informal tones should be avoided. Several important points are discussed below. | ||
| + | |||
| + | === First Person === | ||
| + | For the most part, writing should be | ||
| + | |||
== Organization == | == Organization == | ||
| Line 18: | Line 23: | ||
=== Code Blocks === | === Code Blocks === | ||
| + | |||
| + | === Lists === | ||
Revision as of 08:55, 25 November 2013
This page serves as a set of guidelines for style, formatting, and content across the EMAC Wiki project. While there will be exceptions, following the standards set here will promote consistency and best-practices across the wiki and provide a reference for content review. This guide should be treated as a living document and updated with the current conventions.
Contents
Writing Style
While not completely formal, this wiki is a collection of professional technical documents and should be written as such. Advertising rhetoric, colloquialism, and informal tones should be avoided. Several important points are discussed below.
First Person
For the most part, writing should be
