The Wayback Machine - https://web.archive.org/web/19990202215819/http://teleeducation.nb.ca:80/eastwest/standards/
EastWest Project
Course Developer Guidelines

July 1997 (Draft)

Also see:


Credits

The guidelines were originally developed by a working group led by Prescott Klassen of the Open Learning Agency, Maureen Stanley of the Alberta Distance Learning Centre, Don Whitty of the New Brunswick Community College, Miramichi, Roger Doucet, TeleEducation NB, Rory McGreal, TeleEducation NB, and Leon Cooper of the Ministry of Education of Newfoundland. They were further developed for the TeleCampus by Michaell Elliott, Normand Brunel and others.

The NBCC Miramichi production coordinator responsible for the additional work is Scott Douglas. This is part of the development of procedures for the NB TeleCampus and the Distributed Learning Centre (DLC) of NBCC Miramichi. The guide has been originally drafted, compiled and developed by Judy Breau and Joan Kane (Project Leaders for the DLC), and by Paul Muncaster (TeleEducation NB).

For additional information or updates to the Guide contact:
   Rory McGreal, Director
   rory@teleeducation.nb.ca
   telephone (506) 444-4230.
   ©1997 New Brunswick Distance Education Inc.

Purpose of the Guide

This guide has been created to provide World Wide Web course developers with a set of common standards and guidelines for publishing courses on line. Some of the standards make eminent sense to everyone, others have been agreed to just to ensure that we all develop to a common standard. This makes courses more interchangeable and usable among those who agree to develop to the accepted standards.

Purpose of the Web Pages

The Web page is the common element of all courses developed. It will link all the elements of the course and direct the learner to specific media (Web-based, computer-based, paper-based, audio and/or video materials) or activities. The design model is learning-centred. All courses are asynchronous with the Web environment facilitating the interaction between:
  • the learner and the course material
  • the learner and the instructor/facilitator
  • the learner and peers
The learners will interact through:
  • Online discussion forums
  • Direct e-mail access to the facilitator
  • Content index
  • Help section
  • Glossary
If desired, interaction can also be promoted through live classes or teleconferences, but the courses should stand alone online in an asynchronous environment and not be dependent on live interactions with the teacher or other students.

Policies

Developers should have access to designated areas of the server that houses the course being developed with the following restrictions:
  • Developers will receive one login and password to access the server.
  • The login will position them in the directory in which the course will be developed.
  • Developers will create and modify files in this directory and will not enter other directories, nor read, modify, or delete any other files on the server.

Ethical Use of Web Resources

  • Copyright materials may not be posted without prior permission of the copyright holder.
  • Unpublished information about individuals or organizations may not be made available without permission of the individual or organization.
  • Advertising is NOT allowed on the course pages.

Course Development Procedures

Course development projects should be led by a Project Manager.

The Project Manager is responsible for the coordination and organization of the job and for the ultimate completion of the project. Contact with people outside of the course development team is the responsibility of the Project Manager.

The Project Leader will:
  • Schedule all meetings
  • Answer questions regarding the project
  • Review the concept paper and deliverables
  • Coordinate the sign-off of deliverables
  • Record minutes of meetings and track the progress of the project

Organizational Structure of Content

Structure of the Course Content

Courses developed according to EastWest standards follow a learning-centred model. The course will have four levels. The structure is outlined below. This model will provide consistency for the delivery of these courses via the Web.

Structure Template

Course Introduction (Introduction, Overview, Goal and Objectives)
Module #: Title (Overview & Objectives)
Section #: Title (Overview & Objectives)
Lesson # (Objectives)

At each level, there must be a content-related title with the label. For example:
   Module 1: Doing Presentations; Section 4: Telecommunications; Lesson 2: Networks

More lessons within a section are preferable to long lessons. Short pages of no more than one or two screens are preferable, but longer pages are preferred if the alternative is to split up a topic.

The EastWest Information Technology course template can be used as an example.
   http://teleeducation.nb.ca/eastwest/template/

Course and Module Organizational Pages

Each course should have the following pages:
  • Home Page (bilingual for the Course level page) with links to an English or French
  • Welcome Page or an
  • Index Page(index.html) with links to
    • Help
    • Introduction
    • Course Sections & Lessons
    • Credits
    • Resources
    • Information
    • Glossary


Using hypertext, links can be duplicated where needed. For example, a link to the glossary and introduction could be provided from the student and instructor pages.

Home Page (bilingual) (home.html)
  The bilingual main home page should contain a logo and links to the English and French versions of the course.

Course or Module Index (index.html)
  This is the link to the main body of the course or module. Here are links to the different modules or sections of the course, which in turn lead to the lessons.

Help (or Navigational Tools) (help.html)
  Here you describe the navigational tools used in the course, including the meaning of the buttons and special features. A brief explanation of how to bookmark pages could also be added.

Introduction (intro.html)
  This page should provide a brief description of the goals of the course and some background.

Credits(credit.html)
  This page should give credit to the people and institutions that have suported the development of the course.

Resources (resources.html)
  This page should link to the following resource pages:

  • References Page: List the reference works used in designing the course (refer.html)
  • Online Resources: A list of links to other relevant sites possibly organized according to the different modules and at the module level organized according to sections and lessons. List relevant listservs and newsgroups.
  • Glossary: List and define all new words and technical jargon. (glossary.html)
Information
  This page should provide the following links:
  • Module Outcomes: Include a list of what the student is expected to learn from the course or module. (outcomes.html)
  • Module Outline: Explain the structure of the course or module, listing the titles of the modules, sections and lessons and provide a graphic map. (outline.html)
  • Assessment Information: Here the student is presented with information on how he or she is to be evaluated. What do they have to do to complete the course or module requirements? (assess.html)
  • Instructor Information Include a form for emailing the instructor or facilitators with other useful contact information. (instinf.html)
  • Instructor's Guide: Include advice, tools and instructions for the use of the instructor. (instruct.html)
  • Student's Guide: Here include student information like course prerequisites, a course or module description, expected course outcomes, FAQs, information on discussion groups, MOOs, etc. A link to tutorial resources on using the web would also be useful. (student.html)
  • Hardware Software Requirements: List the minimum hardware requirements and any client-side software that is needed. Provide links to required plug-ins or to software vendors. (require.html)
  • Notes for implementors; Include any comments advice that will help those who are implementing the course or module. (implement.html)

Glossary
  List and define all new words and technical jargon. The definitions to be included should be as brief as possible while still maintaining clarity and the necessary detail. Consistency in wording should be preserved, with all of the definitions either in complete sentences or consistent sentence fragments. An acronym list should also be provided if needed.


Design and Technical Specifications for the Developer

HTML Standards

The approved HTML 3.2 standards may be used for development, including tables, nested tables, and frames. As much as possible, backward compatibility to less well-featured browsers should be attempted.

Minimum browser requirements should be clearly posted on all top pages.

Links to appropriate software (Web Browsers, plug-ins) should be implemented

Low-bandwidth alternatives or low-bandwidth entry pages should be employed in order to channel visitors to the appropriate areas.

Bilingual Design

All top level pages should have links to an English and French sub-page.

A site's HTML structure should be built to mirror the Bilingual design

Images should be created without text unless absolutely necessary to ease translation.

File Size

Course pages, especially the top page, should load as quickly as possible. Therefore, it is important to limit file sizes. The size of individual pages within a module or course should not exceed 100k. Multimedia resources such as Shockwave files and programming scripts such as Java and ActiveX should not exceed 500k. Any links to these resources should state the file size explicitly.

Image File Sizes should follow these guidelines:

Type

Maximum

Size

Maximum

Dimensions

Background tiles

15k

Variable

Icons and navigational buttons

15k

100 x 100 pixels

Context-based images

30k

500 x 500 pixels

Banners and logos

50k

500 x 300 pixels

Animation (Not Java/Shockwave)

75k

500 x 500 pixels

Detailed images, scans

100k

500 x 500 pixels

File Formats

All files created as content pages should be ASCII text files, marked up in HTML.

HTML-generating applications may be used if the resulting documents are saved as HTML.

Images should be in .gif or jpeg format. Any other peripheral file type, if you MUST use it, should be clearly marked and the tool or application required to view this tool should be referenced at that point.

Headings & Titles

Headings should follow the physical typesetting conventions of <H2> for Module/section/lesson and <H3> for subheadings.

Headings may be delimited by colour, assuming that the colour is palette-friendly (see below, Colours), and does not conflict with any existing color scheme and graphics set.

Text

Each content page should show users exactly how far they are into the material. Recommended format at the top right of each page: "page 3 of 7"

Long scrolling pages should be avoided. Limit scrolling to two screens unless dictated by the content. The WWW is a hypermedia environment, pages should use hyperlinks and take advantage of both internal and external resources.

Colours

All graphics designed for the Telecampus and any associated courses and certificates should be designed using the browser-safe 216 colour palette with the exception of scanned art and photographs. Any image designed in a more complex colour scheme should be indicated as such.

Graphics

All graphics should employ the <ALT> tag

All graphics over 30 K in size should indicate the total size in the <ALT> tag

Icons and Bullets should have a simple, representative <ALT> tag. The asterisk "*" is recommended.

Images should be designed to fit on a 640 x 480 pixel screen resolution.

Animated images should have a descriptive <ALT> tag

Icons

On any arrangement of icons or on a toolbar, the most often-used icons should be the furthest to the right close to the scroll bar.

The icon(s) must serve a purpose, and not be simply decorative. The user must know what the icon or button represents before clicking on it. Avoid ambiguous icons.

Documentation

Edit and Author comments should be in the form of hidden text the in the header of the document, and follow a pattern similar to this:

<!--
Internet Publishing, Certificate 2, Unit 3, Lesson 2
Author: Jane Smith Email: smithj@xxnet.xx.ca
Created: June 6, 1997
Edited: June 8, 1997
Editor: John Doe Email: doej@xxnet.xx.ca

-->

All new pages should be time-stamped with the author's name and the creation date

All edited pages should at the least indicate the "Last edited date" in the header information

Meta Tags

To make Web sites easier to find by Search engines and indexing robots and to facilitate the se of new classification systems (General, Adult, etc), general <META> tags MUST be employed on top pages.

Here is an example:.    Information contained in quotation marks is the variable
<META name=resource-type content="document">
<META name=distribution content="LOCAL">
<META name=description content="Description of Document">
<META name=copyright content="Owner of Copyright of Document Content/Design">
<META name=keywords content="Keywords to facilitate Search Engine Indexing">
<META HTTP-EQUIV=Reply-To content="address of author/webmaster">

Page Signature

Index pages, or pages with frequent updates, should be "signed" in the text of the page. The Signature can contain any of these variables: the author's name, the sponsoring organization's name, the creation date, the date of the last edit, the holder of the copyright <

Print-Capable

Main pages, summary pages, syllabi, and all other documents which could be required on a regular basis by the student should be available in a printable format. If possible a word processing format (pdf, .doc or .wpd) as well as simple ASCII document should be made available for downloading.

File Structure and Naming Conventions

In order to maintain the structural hierarchy of course content, courses should use the file system itself to organize the levels of instructional material. Names of directories can function as top level locators and the individual files will be named to reflect the numbering strategies of the design team. Index files will provide the table of contents and fully named file extensions of the next level of course content. Here is a skeletal look at how the file system would work:
    Course: index.html
       -- Module2: index.html
       --- Section2: index.html
       ---- Lesson3: index.html
             one.html
             two.html

Address: http://course/module2/section2/lesson3/two.html

The file naming convention is designed to keep the file names simple, easy to understand and unique in each directory.

Directory

Contents

coursename

All the files in the course

module#

All the files in a specific module

section#

All the files in a specific section

lesson#

All the files in as specific lesson

sub

Glossary, acronyms, tasks, resource, help

test

For tests and exams

master

Final assignments and exams (if protection is necessary)

images

For graphics and animations

movies

For Quicktime and other movie formats

Shockwave

For Shockwave applications




Filenames should be descriptive of their contents, so as their purpose is evident to an outsider. Avoid cryptic designations. Course content pages can be numbered e. g. page1.html (Note that .html cannot be used on Windows 3.x systems. In which case it is reduced to .htm)

Directories should contain the following file names:

Filename

Contents

assess.html

Page with an explanation of how students will be assessed

credits.html

Page for crediting contributors

glossary.html

Glossary

help.html

Help pages

home.html

Home page for the course and module (if not the index)

index.html

Index page. This is essential for all directories

instinf.html

Instructor information page and email link

instruct.html

Instructor’s Guide page

intro.html

Introduction Page

objectives.html

Objectives for the level of the course

outcomes.html

Outcomes

outlines.html

An outline for the level of the course

reference.html

List of references used in the course, module or section.

require.html

List of hardware and software requirements.

resources.html

Resource page

graphicname.gif

Graphics files in .gif format

graphicname.jpg

Graphic files in JPEG format

audiofilename.au

Audio file in .au format

filename.mov

Quicktime movies should be in a Movie directory

filename.xxx

Other formats

page2.html

A normal content page in each lesson directory

page2a.html

An inserted page between page 2 and 3

Page Specifications

The web pages must be developed for viewing on a 640 X 480 pixel resolution monitor which has a usable space of 600 X 350 pixels. For forms that must be printed, the usable space is 535 X 670 pixels for a US Letter size page.

The pages should contain no more than 1 - 2 screens of content. This reduces scrolling.

Graphic Specifications

  1. Sidebars:
       Graphic 1600 X 10 pixels, colour 102 pixels wide, black 7 pixels wide
  2. Graphics:
       Content graphics are graphics used to illustrate a point or to explain an abstract concept.
  3. Graphic Titles:
       10 point (font size -1), centred under graphic
  4. Line Separator
       Centred, thickness of 2, width of paragraph, same colour as sidebar or as defined by colour scheme.

Typographic Specifications

  1. Title
    • 16 point (font size +2) bold, upper and lower case, flush left
    • One line space above
    • Below, one line space if followed by a subtitle, otherwise no following space
  2. Subtitle
    • 14 point (font size +1) bold, upper and lower case, flush left
    • One line space above
    • Below, no following space
  3. Paragraph
    • 12 point (default font size), upper and lower case, flush left, ragged right
    • one line space separating paragraphs, no indentation
    • ~60 characters wide
  4. Copyright
    • 8 point (font size -2), flush left
    • separator, no space, Copyright text
    • Text: © 1997 Institution Name. All Rights Reserved.

Buttons

Each page must allow students to escape and access other parts of the course. The following buttons should be accessible from every page:
  • The E-mail button is a "mail to" link with the instructor’s email address.
  • The Index button links to the Index Page.
  • The Help button links to the Help Page.
  • The Glossary button links to the Glossary Page.
  • The Resource button links to the lesson or section resource page.
  • The Forward button links to the next page.
  • The Back button links to the previous page.
  • The Home button links to the Home page.



All the buttons should have the title of the target page in the ALT option of the IMG tag and in a onMouseOver JavaScript in the A tag. See example below:

<A HREF="../u1.html" TARGET=_parent
onMouseOver="window.status='Unit 1: Introduction
to the Internet';
return true"><IMG SRC="graphics/up.gif"
ALT="Unit 1: Introduction to the Internet" BORDER=0></A>

This allows the name of the target page to appear as a pop-up label in Netscape Navigator 4.01 or later and Microsoft Internet Explorer 3.0 or later. For browsers older than these, the name of the target page appears in the status bar at the bottom of the page.


TeleCampus World Wide Web Course Developer's Guide Evaluation

In order to improve our Web Developer's Guide , we would appreciate your comments.

Date:
Please rate the following:

 

Excellent

Good

Fair

Poor

Presentation of Information        
Organization of the Document        
Helpfulness        
Clarity        
Functionality        
Covers All the Necessary Elements        

What do you like best about the document?
What suggestions do you have for improvement?
Additional comments

Email response to
tenb@teleeducation.nb.ca