Differences

This shows you the differences between two versions of the page.

--- wiki:guidelines [2010/04/28 19:59]
jonyo Further fleshing out this page
+++ wiki:guidelines [2014/09/25 16:55] (current)
@@ Line 1: / Line 1: @@
 ====== Guidelines ======
-Below are some basic guidelines we try to follow for this WIKI so that we can have a level of consistency.  We will be creating/updating these guidelines as needed.  ((Or in this case, creating guidelines to begin with...  We'll be working to create the guidelines soon.))
+Below are some basic guidelines we try to follow for this WIKI so that we can have a level of consistency.  We will be creating/updating these guidelines as needed.
+===== Page Index =====
+The page index, is what would be used to link to the page from another page in the WIKI.  The index will match the end part of the URL for that page as well.  For instance, the URL for the page you are currently viewing is:
+  http://geodesicsolutions.com/support/wiki/wiki/guidelines
+And the **page index** for this page is:
+  wiki/guidelines
+The index, in most cases, will closely match with the page's title.
+The index should use underscore **_** as the **word separator**.((Knowing what we know now about Google recommending the use of hyphen **-** over underscore **_** for the word separator, it may have been better to use hyphens, but we didn't, and it's too late to start doing it now.))
+Only alpha-numeric and underscores _ in the index.  Note that things like & can be used in the page title, but cannot be used for the page index.
+Index should be something simple and short ((Partially so the link to the page is shorter)).  The page title can be longer (although long titles should be avoided if possible), and prone to change over time, but the index will always stay the same so should be short and simple.
+Keep things that are more likely to change over time out of the index, such as "for_version_5".
+===== Page Title =====
+First, you need to know how to make a page title.  It's very simple, the **first headline on the page** is used as the page title.  If you look at the top of this page you'll see the first heading is [[#Guidelines]], and that is what the page title is used for as well.
+The page title is used for the link to the page, and in the page breadcrumb listed at the top of the page.  Keep this in mind when making a title for your page.
+**Including keywords in the title is great**((As long as the keywords relate to the page contents, of course.)) since it makes the page show up in relevant searches better, but **not at the expense of making sense**.  Make sure you are not over-doing keyword usage.  A good rule of thumb is to try to make the title as **short as possible**, while still being descriptive enough so that people know right away what the **page is for** without having to open the page and read the contents.
+Put what it is at the beginning of the file.  If you //must// add a few extra keywords to the title to make the page show better in searches, word it so the secondary keywords are at the end.  For example "Performance Tips for Classified and Auction Software" instead of "Classified and Auction Software Performance Tips", the former is easier to spot when you are skimming the menu for a page.
 ===== Use of Folders & Pages =====
@@ Line 36: / Line 66: @@
 ===== Acronyms =====
-For any Acronym, the case matters!  Use the proper case for the acronymn, usually this will be all uppercase((But not always, for example MySQL it is common to have all uppercase except for the y.)).  This WIKI will recognize common acronyms and add a hover that tells what the acronym means, for example the acronym WYSIWYG.  If improper case is used, the WIKI will not recognize it and will not show what it stands for, for instance if you used wysiwyg((NOTE:  We break the acronym guideline here on purpose to illustrate the point of why the case matters on acronyms.)) instead of WYSIWYG.
+For any Acronym, the case matters!  Make sure you always use the proper case for the acronym((You can usually spot them easy enough, in Firefox it will have the red dotted line under the acronym as if it was misspelled.)), usually this will be all uppercase((But not always, for example MySQL it is common to have all uppercase except for the y.)).  This WIKI will recognize common acronyms and add a hover that tells what the acronym means, for example the acronym WYSIWYG.  If improper case is used, the WIKI will not recognize it and will not show what it stands for, for instance if you used wysiwyg((NOTE:  We break the acronym guideline here on purpose to illustrate the point of why the case matters on acronyms.)) instead of WYSIWYG.
-A few common Acronyms that are recognized by the WIKI: URL, WYSIWYG, WAMP, PHP, IP, plus a ton others.  If you find that an acronym is not recognized by the WIKI and you have used the proper case, let us know and **we can add it**.
+A few common Acronyms that are recognized by the WIKI: URL, WYSIWYG, WAMP, PHP, plus a ton others.  If you find that an acronym is not recognized by the WIKI and you have used the proper case, let us know and **we can add it**.

Geodesic Solutions Community Wiki

User Tools

Site Tools

Differences

Page Tools