| File and Folder Structure |
|
| Folder names are capitalized (i.e. .../Folder/ ) |
|
| File names are in lowercase (i.e. window.html) |
|
| Files live in a main folder with their images (and .png's). |
|
| Images are in a separate folder (inside the main document folder) named Images. |
|
| All images in the Images folder are in either .gif or .jpg format |
|
| .png files are saved in a separate PNG folder inside the main folder and never uploaded. |
|
| If working on a pre-existing webpage, never re-name a file until staff verifies. |
|
| Make sure the webpage file(s) have the extension .html. |
| Writing Documentation |
|
| Screen shots are made whenever necessary, and are precisely accurate. |
|
| All platform variations are documented. |
|
| Make sure all windows, dialog boxes, menu items, text fields, and buttons are precisely named. |
|
| Steps are broken down using bullets or ordered lists, and every step is thoroughly documented. |
|
| When the user has a choice of options, each alternative is clearly explained and an appropriate recommendation is given. |
|
| All general concepts are clearly defined, and the level of technicality and/or any assumptions of prior knowledge are appropriate for the intended audience. |
|
| The instructions have been tested step by step, and each step was followed exactly as written |
|
| Menu items, buttons, keys, items to be selected or the exact text that needs to be typed are bolded (i.e. Click OK. Type wellesley.edu.). |
|
| Names of fields or lists and examples of text to be typed are italicized (i.e. Type your username - e.g., wwellesl). |
|
| Separators (>) are used between menu names and their options (i.e. Choose File > Open.) |
|
| Key names are in capital letters (i.e. Press ENTER. Press CTRL + ALT + DEL.) |
|
| When directing the user to press multiple keys simultaneously, the "+" is employed. (see above example.) |
|
| Quotation marks are avoided. |
|
| Spelling, mechanics, and capitalization are correct. Typographic conventions are observed. |
|
|
The document uses clear, simple grammar and professional
tone. |
|
|
Advanced Pop-up menus follow these Fireworks
directions. |
|
|
Follows "Best
Practices" for Wellesley College web publishing |
| Documentation Properties |
|
|
A viewable screen size .jpg must be no larger than 950 x
825 pixels. |
|
| Documentation logo is inserted in upper left corner. |
|
| Dogtag (with staff name, department, date created, last modified, and expiration date) |
|
|
The name of the student and their graduation year may be added as
a second credit line (Created by: Wendy Wellesley '07). |
|
| Expiration date is approximately one year away but is stated as either July 1 or January 1. |
|
| All images have ALT tags. |
|
| Spell checked in Dreamweaver (Text > Check Spelling). |
|
| Webpage does not use frames (use tables instead), unless otherwise directed. |
|
| Add links at the bottom to other computing documentation, a "back" link to the previous page or a "back to top" link in long documentation. |
| Appropriate title (Dreamweaver > Modify > Page Properties > Title) |
|
| All links and anchors must be checked to make sure they work. |
| The document is neatly formatted. |
| Webpage Testing |
|
| Viewable
at different monitor resolutions (ie. user does not need to scroll
horizontally). |
|
|
Viewable in a browser through Windows and on a Mac. |
|
|
Document prints quickly and correctly. |
|
|
Viewable in all versions of Internet Explorer and
Netscape |
