Documentation/Maemo Documentation Guidelines/Introduction

(categorize)
(wikify image formatting)
 
(One intermediate revision not shown)
Line 1: Line 1:
-
= Introduction =
+
''Maemo Documentation Guidelines'' is meant for Maemo documentation purposes only. This guide presents the general guidelines to be followed when writing and editing technical documentation for all Maemo platform and Maemo device releases, figure [[#figure-documentation_guidelines-introduction-n900|1.1]].
-
 
+
-
''Maemo Documentation Guidelines'' is meant for Maemo documentation purposes only. This guide presents the general guidelines to be followed when writing and editing technical documentation for all Maemo platform and Maemo device releases, figure [[#fig:documentation_guidelines-introduction-n900|1.1]].
+
-
 
+
-
 
+
-
 
+
-
{| summary="Maemo device - N900"
+
-
|+ align="BOTTOM" |'''Figure 1.1:''' Maemo device - N900
+
-
|-
+
-
|
+
-
[[Image:Nokia_N900_20.png|Image Nokia_N900_20]]
+
-
|}
+
-
 
+
 +
<div id="figure-documentation_guidelines-introduction-n900">
 +
[[Image:Nokia N900 48.png|frame|center|alt=Photo of N900 with extended hardware keyboard|Figure 1.1: Maemo device - [[Nokia N900|N900]]]]
 +
</div>
''Maemo Documentation Guidelines'' provides editorial guidelines for content published by Maemo electronically or in print, including white papers, case studies and success stories, tutorials, technical documentation, news stories, Web pages, Web teasers and blurbs, and marketing material such as developer catalogues and brochures.
''Maemo Documentation Guidelines'' provides editorial guidelines for content published by Maemo electronically or in print, including white papers, case studies and success stories, tutorials, technical documentation, news stories, Web pages, Web teasers and blurbs, and marketing material such as developer catalogues and brochures.
Line 26: Line 17:
Certain points made in the reference materials above are repeated in this document for emphasis. With newly created content, follow the guidelines. When working on older, existing content, incorporate as many of the guidelines as possible, while maintaining consistency within each document or other unit of content.
Certain points made in the reference materials above are repeated in this document for emphasis. With newly created content, follow the guidelines. When working on older, existing content, incorporate as many of the guidelines as possible, while maintaining consistency within each document or other unit of content.
-
Also note that ''The Elements of Style'' <ref name=r3>The Elements of Style. http://en.wikipedia.org/wiki/The_Elements_of_Style</ref> provides excellent general guidance on language usage, composition, and style, and that ''The Associated Press Stylebook'' <ref name=r1>The Associated Press Stylebook. http://www.apstylebook.com/</ref> is useful for issues of journalistic type, such as geographic references, that may come up in newsletters and the like.
+
Also note that ''The Elements of Style'' <ref name=r3>[[:wikipedia:The Elements of Style|The Elements of Style]].</ref> provides excellent general guidance on language usage, composition, and style, and that ''The Associated Press Stylebook'' <ref name=r1>The Associated Press Stylebook. http://www.apstylebook.com/</ref> is useful for issues of journalistic type, such as geographic references, that may come up in newsletters and the like.
Using this document by searching through it electronically is highly recommended. This guide largely follows the editorial style it recommends and can therefore in general be used as a style model. The comment do not use means precisely that; avoid means do not use except when nothing else will do.
Using this document by searching through it electronically is highly recommended. This guide largely follows the editorial style it recommends and can therefore in general be used as a style model. The comment do not use means precisely that; avoid means do not use except when nothing else will do.
-
Feedback about this guide is always welcome. In addition, before each version of the guide is distributed generally, a draft is sent out for review. Feedback or style queries should be directed to <span><font face="monospace">documentation@maemo.org</font></span>. Updated versions of this guide are released periodically.
+
Feedback about this guide is always welcome. In addition, before each version of the guide is distributed generally, a draft is sent out for review. Feedback or style queries should be directed to [mailto:documentation@maemo.org documentation@maemo.org]. Updated versions of this guide are released periodically.
 +
== References ==
-
 
-
----
 
-
== References ==
 
<references />
<references />
[[Category:Documentation]]
[[Category:Documentation]]

Latest revision as of 13:07, 10 November 2010

Maemo Documentation Guidelines is meant for Maemo documentation purposes only. This guide presents the general guidelines to be followed when writing and editing technical documentation for all Maemo platform and Maemo device releases, figure 1.1.

Photo of N900 with extended hardware keyboard
Figure 1.1: Maemo device - N900

Maemo Documentation Guidelines provides editorial guidelines for content published by Maemo electronically or in print, including white papers, case studies and success stories, tutorials, technical documentation, news stories, Web pages, Web teasers and blurbs, and marketing material such as developer catalogues and brochures.

The following resources supplement this document:

In cases where guidelines in two or more resources conflict, the ones in Maemo Documentation Guidelines document take precedence, followed by the documents above in the order listed with the exception of spelling concerns. To resolve spelling concerns for words or terms, first consult the Collins English Dictionary.

Certain points made in the reference materials above are repeated in this document for emphasis. With newly created content, follow the guidelines. When working on older, existing content, incorporate as many of the guidelines as possible, while maintaining consistency within each document or other unit of content.

Also note that The Elements of Style [4] provides excellent general guidance on language usage, composition, and style, and that The Associated Press Stylebook [5] is useful for issues of journalistic type, such as geographic references, that may come up in newsletters and the like.

Using this document by searching through it electronically is highly recommended. This guide largely follows the editorial style it recommends and can therefore in general be used as a style model. The comment do not use means precisely that; avoid means do not use except when nothing else will do.

Feedback about this guide is always welcome. In addition, before each version of the guide is distributed generally, a draft is sent out for review. Feedback or style queries should be directed to documentation@maemo.org. Updated versions of this guide are released periodically.

[edit] References

  1. ↑ Nokia A-Z Marketing Language Guide. http://brandbook.nokia.com
  2. ↑ Nokia Brand Book. http://brandbook.nokia.com
  3. ↑ Collins English Dictionary. http://www.collinslanguage.com
  4. ↑ The Elements of Style.
  5. ↑ The Associated Press Stylebook. http://www.apstylebook.com/
Retrieved from "http://wiki.maemo.org/Documentation/Maemo_Documentation_Guidelines/Introduction"