Naming Conventions and Standards
Filenames (as indicated in the AIS Web Style Guide):
- lowercase
- .html extension
- Underscores between words; for example, "web_standards" or "request_for_service".
- Names are to be short and to the point; for example, "PC_Replacement_Program_Policy_and_Guidelines.doc" changed to "pc_replacement.doc"
- Avoid redundant terms; for example, "ais_standards_and_guidelines" changed to "standards_and_guidelines.html". In this case, ais is redundant because the files reside within the AIS site.
PowerPoint Presentations:
- No PowerPoint presentations unless information isn't readily available on the AIS Web site. Those PowerPoints used must be reviewed by the editor prior to releasing.
Word, PDF and other non-HTML files:
- HTML format is preferred
- If a document is subject to frequent adjustments or will be printed by users, Word format is suggested for its ease of use and printability
- Use Documentation Download page (template provided) to build a consolidated environment for related documentation
Labels:
- Initial caps
- Short and to the point
- Aid page scanning and legibility
- Use subheads to break up long text passages
- If used, horizontal rules must be placed above subheads
- Use matching typography for headlines, subheads and pull-quotes
Examples of labeling standards throughout the AIS Web site:
- Headline for systems help page: AIMS Help
- Headline for systems access page: AIMS Access
- Headline for systems connecting page: Logon to AIMS -or- Connecting to AIMS
- Headline for listserv pages: Data Warehouse Listserv
- Headline for user group pages: eCommerce User Group
- Headline for changing password pages: Changing Your Data Warehouse Password
- Headline for section contact page: eCommerce Contact Information
- Headline for section pages: full name followed by acronym, i.e. Integrated Business Information Systems (IBIS)
- Referring to a system or service in Text area for section pages: use acronym in leading sentence.
|