Best Practices

Best Practices for Editing TRU-OL Curriculum Materials

[for checklists: expand each item in the list to link to subpage]

Conduct a Pre-Edit

Before starting to edit a course, confirm with Editing Coordinator (Brian):

Issue (course) has been entered in JIRA[link] and assigned to you
Confirm any info that might impact the editing process
Check the Course Maintenance Proposal (CMP) to confirm the stakeholders, time lines, and the scope of work

Consult with Stakeholders

Verify the following with the instructional designer (ID), course lead, subject matter expert (SME), or course writer:

Scope of edit: Normally the course lead or instructional designer decides the scope of editing required; however, the editor must inform them if the course has substantive or design problems that require more work. The scope may change as editing proceeds and may differ from information captured in the Course Maintenance Proposal (CMP) or JIRA.
How to handle duplicate edits (for a standard web (SW) and print (PT) course, for example) (D-L, does this "duplicate edits" mean editing for different modalities?)
How to handle URLs: best practice is as weblinks with author/originator stated, title of resource in bold font, URL provided, instructions to Production
How to handle works cited, bibliography, or lists of resources (provide short lists in module or unit and references list at end of course)
Whether to and where to provide a resources page
Layout in the web (for example, if the Course Schedule will have a separate page or be included in the Course Guide)
Confirm with the SME or ID what citation style is to be used (generally, either APA or MLA)

Verify with the curriculum assistant:

Details of the textbook(s) (name, author, edition); companion website; and other resources
Editor's access to the resources (get the textbook)

Set up or use a style sheet:

Either set up a new style sheet or get one from the previous editor
Check the existing course files in Blackboard Learn[link], in print, or check the Word files. Note the editorial style choices already made for the course.

Set up the course folders and files:

Save all original files with their original names
Save all original files renamed according to File Naming Conventions[link]
In the renamed files, accept all changes (if any remain) but keep any comments by previous reviewer

Back up all materials on the O: drive:

Use a folder under O: Open Learning Share> Curriculum Services> editing [check] and back these up each day

Document the Pre-Edit Work in JIRA:

Enter any relevant comments regarding previous edit and scope of the current one
Log preliminary work

Edit the Course

Differences between substantive editing and copy editing
(perhaps we should have a team conversation about best practices for this section)

Create or Use a Style Sheet

What is a style sheet?
How to create one?
The benefits of using a style sheet are...?
Create, use and expand on the style sheet [link to example]

How to Document and Track Your Work

JIRA is software we use for tracking issues and for effective project management.

Log your work in JIRA as you edit the course.

If there are two methods of delivery (MODs), log the relevant work under each one in the Time Tracking field.

Enter comments for top-level information (from which an editing memo can be made) on the main page. Enter comments for granular information under the log work page.

If needed, use JIRA to document editorial comments about the course. Comments could include: progress made in the course, outstanding issues, suggestions for future revision, and/or queries to stakeholders.
Note: The comments you write in JIRA can be read by all editing team members, but other stakeholders can not see them or respond to them.

Estimate percentage of work done.

Send Documentation

Email edited Course Guide to the appropriate CA:

CA Business: CA1@tru.ca[link]
CA Arts: CA2@tru.ca[link]
CA Health: CA3@tru.ca[link]

Use Generic [use other word?] Email Addresses

Some OL teams do work on campus or work with several other teams so they might have generic sites. Rather than email a particular person in the Intellectual Property Office (IPO), for example, we use the IPO's generic email address. Generic email addresses:

 * Copyright: Copyright@tru.ca[link]
 * CA Business: CA1@tru.ca[link]
 * CA Arts: CA2@tru.ca[link]
 * CA Health: CA3@tru.ca[link]
 * Media Services : media@tru.ca [verify][link]
 * Course Lead (Naomi) and Project Manager (Andrea C): CurriculumServices@tru.ca[link]
 * Exams (Jennifer C): CSexams@tru.ca