cordova-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From mwbro...@apache.org
Subject [3/3] docs commit: [CB-3962] additional stylesheet items
Date Fri, 05 Jul 2013 18:00:37 GMT
[CB-3962] additional stylesheet items


Project: http://git-wip-us.apache.org/repos/asf/cordova-docs/repo
Commit: http://git-wip-us.apache.org/repos/asf/cordova-docs/commit/c3120404
Tree: http://git-wip-us.apache.org/repos/asf/cordova-docs/tree/c3120404
Diff: http://git-wip-us.apache.org/repos/asf/cordova-docs/diff/c3120404

Branch: refs/heads/master
Commit: c31204047c55ee9c4f17ea2e6ec04b9f3d7d6c3b
Parents: 8c1ec3f
Author: Mike Sierra <letmespellitoutforyou@gmail.com>
Authored: Fri Jul 5 12:08:59 2013 -0400
Committer: Michael Brooks <michael@michaelbrooks.ca>
Committed: Fri Jul 5 10:58:55 2013 -0700

----------------------------------------------------------------------
 STYLESHEET.md | 21 ++++++++++++++++-----
 1 file changed, 16 insertions(+), 5 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/c3120404/STYLESHEET.md
----------------------------------------------------------------------
diff --git a/STYLESHEET.md b/STYLESHEET.md
index c2e8170..aab51b7 100644
--- a/STYLESHEET.md
+++ b/STYLESHEET.md
@@ -44,7 +44,7 @@ editorial guidelines.
 
 * Do not combine in-line formatting such as _`monospace italic`_.
 
-## Language
+## Language and Tone
 
 * Use present tense. "This happens," not "this will happen." (Future
   tense sounds like a tenuous prediction.)
@@ -73,9 +73,13 @@ editorial guidelines.
   am going to show you now." Likewise avoid "we," as in "We see
   that..."
 
-* OK to refer to "you," the developer, but it should be minimized.
-  E.g., instead of "...for which you need to invoke the `Contact.save`
-  method", try "...for which the `Contact.save` method is required."
+* OK to refer to "you," the developer, but only if necessary, e.g., to
+  avoid passive voice.
+
+* Avoid unnecessarily imperative statements, especially using the word
+  "must." E.g., instead of "Commands must be run from a cmd or
+  powershell prompt," try "You can run commands either from a cmd or
+  powershell prompt."
 
 ## Usage
 
@@ -83,6 +87,8 @@ editorial guidelines.
   developer. Refer to plural "users" as "they" to avoid singular
   he/she pronoun problems.
 
+* WebView, not Webview. (OK to use lowercase webview in code)
+
 * 'Directory', not 'folder'; may be exceptions in some GUI contexts
 
 * 'Press' a button on the screen; 'type' a key; do not 'hit' either.
@@ -120,6 +126,12 @@ editorial guidelines.
   sentences. No periods when bullets are sentence fragments. However,
   bullet lists should be internally consistent.
 
+## Common Grammatical Errors
+
+* Do not use use apostrophes for plural, so "...manages core APIs,"
+  not api's or API's. Only use apostrophes for possessives, e.g. "the
+  API's members"
+
 ## Miscellaneous
 
 * For procedure lists, don't break out separate items for (1) do this,
@@ -136,4 +148,3 @@ editorial guidelines.
   matters, or __TIP:__ to pass along useful tricks or context.
 
 * Use titles in link text, never 'click here'
-


Mime
View raw message