Contensive Best Practice Guide - Revision history

Admin: /* Website Patterns */

2015-07-22T15:00:54Z

‎Website Patterns

Admin: /* Security, IT and Hosting */

2015-07-22T14:54:52Z

‎Security, IT and Hosting

Admin: /* Email Design */

2015-07-22T14:53:09Z

‎Email Design

Admin: /* Design */

2015-07-22T14:52:44Z

‎Design

Admin: /* Design */

2015-07-22T14:46:06Z

‎Design

Admin: /* Design */

2015-07-22T14:45:40Z

‎Design

Admin: /* Website Patterns */

2015-07-22T14:43:10Z

‎Website Patterns

Admin: /* Addons */

2015-07-22T14:42:05Z

‎Addons

Admin at 14:33, 22 July 2015

2015-07-22T14:33:47Z

Admin: /* General Development */

2015-07-22T14:30:20Z

‎General Development

@@ Line 2: / Line 2: @@
 ==Website Patterns==
 ===Website Forms===
 ===Website Templates===
 ===Online Applications===
 ==Software Development==

@@ Line 96: / Line 96: @@
 * Folders that contain images, etc should be named to guarantee they are unique within the site. For instance, never user “image” or “img” or “styles”.
 ==Security, IT and Hosting==
 See Google docs /PracticesPolicies for more information

@@ Line 91: / Line 91: @@
 ===Email Design===
-All email styles must be included in-line, never in a remote stylesheet.
+* All email styles must be included in-line, never in a remote stylesheet.
-Email designs must render acceptably though our email test service, Litmus.com
+* Email designs must render acceptably though our email test service, Litmus.com
-We must support all email clients with 5% marketshare, determined by the litmus.com site http;//www.emailClientMarketShare.com
+* We must support all email clients with 5% marketshare, determined by the litmus.com site http;//www.emailClientMarketShare.com
-Folders that contain images, etc should be named to guarantee they are unique within the site. For instance, never user “image” or “img” or “styles”.
+* Folders that contain images, etc should be named to guarantee they are unique within the site. For instance, never user “image” or “img” or “styles”.
 ==Security, IT and Hosting==
 See Google docs /PracticesPolicies for more information

@@ Line 55: / Line 55: @@
 ==Design==
-Best practices are practices, not policies. They should be followed as a rule but are not required. (This means they should be followed unless there is a reason for each case)
+Best practices are practices, not policies. They should be followed as a rule but are not required. (This means they should be followed unless there is a reason for each case) The goal of best practices is to develop habits that result is higher quality products. Include a brief summary of the practice, and an explanation with a reason why and a goal.
-−
 The goal of best practices is to develop habits that result is higher quality products.
-−
 Include a brief summary of the practice, and an explanation with a reason why and a goal.
 General
 * No inline script throughout the document body, script should either be referenced in the HEAD section or just before the end BODY tag in a single SCRIPT tag.
-* The HEAD section of a document should be organized. All like entities should be grouped together, i.e. scripts, css.
+* All scripts/css/images should be referenced using absolute URLs, not relative.
-* No absolute positioned elements, everything should be relative and respond to the browsers orientation/size.
+===CSS===
-* All scripts/css/images should be referenced using relative URLs, not absolute
+* Styles used within body content (the content box) should not require wrappers outside the content box. For instance, an h3 within the content of the aboutUs page should never be styled with a class from the body tag, unless that tag is used universally through the site.
-* Menus should be constructed with UL and LI - no IDs should be used to style menus, only CLASS attributes. All menu links should be wrapped in an HTML anchor. Class names are entirely up to you - i.e.
+* Site templates should include a page of sample text as a style guide. Each line should show and describe all styles for use throughout the site.
 <pre>
 <ul class="menu">
@@ Line 92: / Line 88: @@
 <ul>
 </pre>
-Email Design
+===Email Design===
 All email styles must be included in-line, never in a remote stylesheet.
 Email designs must render acceptably though our email test service, Litmus.com

@@ Line 71: / Line 71: @@
 * All scripts/css/images should be referenced using relative URLs, not absolute
 * Menus should be constructed with UL and LI - no IDs should be used to style menus, only CLASS attributes. All menu links should be wrapped in an HTML anchor. Class names are entirely up to you - i.e.
 <ul class="menu">
      <li class="menuItem active">
@@ Line 90: / Line 91: @@
      </li>
 <ul>
 * Styles used within body content (the content box) should not require wrappers outside the content box. For instance, an h3 within the content of the aboutUs page should never be styled with a class from the body tag, unless that tag is used universally through the site.
 * Site templates should include a page of sample text as a style guide. Each line should show and describe all styles for use throughout the site.

@@ Line 1: / Line 1: @@
 This page includes our best practices guidelines.
 ==Website Patterns==
 ==Software Development==
 ===Addons===

@@ Line 3: / Line 3: @@
 ==Software Development==
 ===Addons===
-* Should be named legibly.
+* RemoteMethod addons should be camel-case with no spaces.
 * Should be contained within a Collection.
 * Should have Presentation set (Tool/Report/Setting/Addon).
 * Should populate name fields in all records that are created.
-* Should be done with Layouts.
+* Public facing Html should be generation using layouts records and/or html file.
-* Should handle visit timeouts gracefully, returning users to the beginning of the process with an error message.
+* Administrative screen Html should use layouts, html files or internal html methods.
 ===Logins===

← Older revision		Revision as of 14:33, 22 July 2015
Line 45:		Line 45:

	==Design==		==Design==
		+	==Security, IT and Hosting==
		+	See Google docs /PracticesPolicies for more information

@@ Line 33: / Line 33: @@
 ===General Development===
-Best practices used within general development would require code review and can not be incorporated into each test plan.
+* Best practices used within general development would require code review and can not be incorporated into each test plan.
-Browser Compatibility
+===Browser Compatibility===
 We will use w3Schools.com to determine the current browsers. ON the Menu as Browser Statistics. Any browser with > 5% usage will be included by default. The client is welcome (encouraged) to include other browsers with appropriate labor requirements.
@@ Line 43: / Line 43: @@
 The testing practices document will include a line item that says we test for browsers listed in the project requirements.
 We will create a new product under products and services to offer ongoing browser testing as a monthly service.
 ==Design==