For the English Site
Template
Confirm that the page has been created using the correct template.
Components
Confirm that the page has been created using the correct components.
- Remove any components that are extraneous
- Fix any components that are authored incorrectly
- Do not leave any empty components on the page (exception: Layout Containers in Hero Banners).
- Remember that Background Container and Hero Banner are parallel to each other in hierarchy; Hero Banner should not be placed within Background Container
- Separator should be used very sparingly; use padding within other components, when possible, to add space between components rather than using Separator
- If there is one Smart Button in Hero Banner, it must go in the first slot - not the middle slot; if you don’t, the text and button will not align in the banner
- Top Banners should use Primary Button (Blue) in the first slot, Secondary Button (White) in the second slot; Offer and Form Banners should use Secondary Button (White) only
- Use one Background Container per stack of content; do not try to put several vertical elements into one Background Container; the spacing between elements will not look correct (EXCEPTION: Do not put Hero Banner inside a Background Container; it is not necessary because that component is designed to be full width)
- Background Container should almost always use 40 px for both Top and Bottom Padding
- There should never be 3 Smart Buttons in a Hero Banner
- There should be only 1 Primary Button per page; it will most likely be in the Top Banner
- Verify all banners and CTAs have been set up correctly for lead routing
Content Tree
Confirm that the page has been created with the correct Content Tree.
Page Properties
Verify all Page Properties fields have been completed correctly and thoroughly.
- Verify page file names follow these guidelines:
- No empty spaces (this causes a %20 to show up in empty space, which makes URL hard to read)
- All lowercase letters
- Hyphens (-) instead of underscores (_) between words
- No special characters, such as ampersand (&), comma (,), apostrophe ('), quotation mark ("), pipe (|)
- English words only - no translated terms
- Restrict length to xx characters
- Page Title and Description SEO fields are critical to driving external traffic to the site and for displaying internal Coveo search results for Page Types
- Tags are critical:
- To facets in Coveo search pages and filters in Office Locations
- To Dynamic Tags within Card Images and Card Perspectives
- To Adobe Target
- Page Label is required to display in internal Coveo search results for Page Types and Content Types
- Card Properties are critical to the functionality of the Coveo search results for Content Types and some Product fields, as well as for dynamic cards in Card Carousel and Card 2x2 Section Layout
Assets
Verify assets have been correctly hosted per the assets governance.
- Be careful to keep images under /images and documents under /documents. Do not put them in the wrong asset type folders.
- Confirm all file names are following these guidelines:
- No empty spaces (this causes a %20 to show up in empty space, which makes URL hard to read)
- All lower case letters
- Hyphens (-) instead of underscores (_) between words
- No special characters, such as ampersand (&), comma (,), apostrophe ('), quotation mark ("), pipe (|)
- English words only - no translated terms
- Restrict length to xx characters
Brand Review
Verify the following are on brand:
- Heading text letter casing
- Call to action text and letter casing
- Product names (AVEVA included or not; trademark symbol or not)
- Images (add alt text and add link, if appropriate)
- Documents (exception: partners selling products linked from /products may use their own branding for their documents)
- Video play icon, menu bar, bumpers (should be purple; if pink, blue, or green, update branding)
Copyedit/Proofread
Verify the Web Writing Guidelines have been followed:
- Update any British English spellings to American English (Exceptions: press releases, investor content, legal content)
- Review for spelling, grammar, and punctuation errors
- Confirm the levels of headings are correct
- Confirm letter casing is correct
<br> tag
Audit all WYSIWYG fields to ensure the <br> tag is not used incorrectly.
The <br> tag SHOULD NEVER be used in the middle of a phrase or sentence to accommodate front-end design. This may break responsive design rules in different viewports, and more importantly, it will result in an incorrect translation.
Relative Paths vs Absolute URLs
Review all links to ensure they are following the correct rules for relative paths vs full absolute URLs.
- Relative path is used in the following scenarios:
- When linking to any page within the same language site hosted within AEM
- When linking to any asset hosted within AEM Assets
- Absolute URL is used in the following scenarios:
- When authoring in one of the AVEVA websites hosted on www.aveva.com or www.aveva.cn and adding a link to another language site hosted on www.aveva.com or www.aveva.cn
- When linking to a third party asset
- When linking to a third party webpage
- An AVEVA site that is not hosted on www.aveva.com or www.aveva.cn is considered to be a third party site in terms of AEM authoring rules
- engage.aveva.com
- investors.aveva.com
- softwaresupportsp.aveva.com
- etc.
- An AVEVA site that is not hosted on www.aveva.com or www.aveva.cn is considered to be a third party site in terms of AEM authoring rules
Synonyms
Audit content to see if any terms need to be added into the Coveo thesaurus.
For Translated Sites
Follow all of the guidelines above, as well as the guidelines below.
Translation Terminology
- Identify any new terms that should be flagged in Smartling for DNT (Do Not Translate), such as product names, brand terms, taglines, third party company names, etc.
- Identify any new terms that should be translated a specific way for AVEVA messaging for Smartling termbase