HomePreparing Lecture Materials

Preparing Lecture Materials

Guide for Preparing Lecture Materials for the InnovPrecMed Project

This guide outlines how to prepare lecture materials for the InnovPrecMed project, with a focus on consistency, clarity, and multimedia integration.

Composition of Lecture Notes

Lecture notes for one educational unit (a course) should include the title, subtitle, an introductory page, and chapters.

Title and Subtitle

  • Title: Up to 60 characters
  • Subtitle: Additional information, up to 60 characters

Introductory Page

The introductory page presents the educational unit and should include:

  • A motivational overview: one or two paragraphs explaining what the course is about and why it is valuable.
  • Additional materials (optional): one paragraph with links to supplementary content.
  • Credits: a paragraph listing the authors or developers of the material and the license under which the content is released.
  • Image/logo: include a .png image with logos or relevant branding.

Chapters

Each chapter should be a self-contained sub-unit of the course. It should be understandable on its own, even when accessed independently from other chapters. This means each chapter must provide enough context, explanation, and supporting materials to allow a learner to grasp the key ideas without relying heavily on previous content (though cross-referencing is allowed). Each chapter should include:

  • Short title: Up to 30 characters
  • Introduction and motivation: One or two paragraphs introducing the topic and its importance
  • List of concepts: A list of key concepts, each with a one-sentence explanation
  • Main content: Include text, images, and/or videos as appropriate
  • Quizzes or evaluation material: Optional, but recommended. If the evaluation is extensive, it can be presented as a separate chapter.

Note: Ensure that any multimedia elements (images, videos) are clearly tied to the chapter content and enhance understanding. Images may appear inline, span full width, or be used as side notes.

Examples of Existing Material

  1. Introduction to Machine Learning — Video-focused lecture material.
  2. Survival Analysis with Visual Analytics — Text-based material with integrated images and side notes.

Please refer to these examples for formatting and content structure inspiration.

Preparation of the Material

Ideally, all materials should be prepared as a collection of Markdown files and image files, organized in clearly structured directories. Alternatively, and actually expected for all contributors that are not familiar with this format, the material should be prepared as a set of MS Word documents with accompanied images delivered outside the word documents. We provide an example set of materials with three chapters, available as:

  • A zipped package of Markdown files, and
  • An alternative version in Microsoft Word format.

Important: If you choose to prepare the content in MS Word, please note that we will convert it into Markdown before publication. Use clear and consistent formatting in the Word document to ease conversion.

Submission

Please submit the complete material as a single ZIP file by email to [email protected], CC to [email protected].

Chapters