Tutorial Styleguide

General Notes:

 * Write tutorials in the active voice.
 * When giving instructions, write in the second person
 * Always break instructions down into numbered steps (using numbered lists to do so)
 * Always using heading tags appropriately. The top-level headings should be H2 (as the page title itself is H1). Cascade titles below H2 appropriately.
 * When linking to another page, do not use the word "here" as the text of the link. Instead, extend the link so that it includes more contextual information about where the link goes CORRECT: View larger version on Flickr here. INCORRECT: View larger version on Flickr here.

Terminology (refer to the following topics/terms as shown below) :

 * UMW Blogs: The Wordpress platform hosted by DTLT at UMW.
 * WordPress: The platform that UMW Blogs runs on.
 * frontend: The forward-facing portion of a UMW Blogs site (that is visible to the audience)
 * backend: The administrative portion of a UMW Blogs site (that only users of the site can see)
 * quick menu: The gray bar that shows up at the top of the page when you are logged into UMW Blogs.
 * admin menu: The left-hand menu that shows up when you are in the backend.
 * admin menu item: A top-level item in the admin menu.
 * admin menu subitem: An iatem in the admin menu that is below a top-level item.

Other words/terms (please refer to them as shown below)

 * login, logging in
 * logout, logging out
 * email
 * web site

Common styles:

 * When referring to a admin menu item, put it in bold EX: Click Appearance in the admin menu.
 * When referring to an admin menu item, use carrot symbols to clarify the path of navigation. EX: Click Appearance < Widgets in the admin menu.
 * When referring to a button (to be clicked) or a text link (to be clicked), put it in bold. Ex: When you are done, click the Save button.
 * When referring to an area of the page by title, put the title in quotes EX: Click on the Logout link in the "Login" section of the page.
 * Whenever you spell out an entire URL, include a link.

Images/Screenshots:

 * Use Jing to capture all screenshots for the site.
 * Screenshots should only include the content of the browser window. Do NOT include any browser chrome or other elements open on your screen.
 * Whenever possible, capture a full browser window. When you are focusing on a specific part of a page, it is appropriate to capture an image that is cropped to just that area.
 * Use the built-in annotation tools in Jing to add red arrows, boxes, and text to callout and annotate parts of the page in an image.
 * Upload all images to DTLT's Flickr site with the tag "umwblogshelp." Use the 500px width version of the image you upload to Flickr to embed it in the wiki page. Below each image include a link back to the larger version of the image with the text "For larger version on Flickr click here."