Logo

Creating a teaching document

This use case describes the efficient and standardized creation of teaching materials by lecturers. The teaching document is created and available to students.

Idea
Plan
Prototype
Pilot
Live

Overview

Value: This use case describes the efficient and standardized creation of teaching materials by lecturers. The teaching document is created and available to students.

Problem: The inefficient and inconsistent creation of teaching materials due to the absence of a standardized, automated, and version-controlled workflow.

Solution: The teaching document is created and available to students.

Who Benefits

Primary

  • Lecturers

Secondary

  • Students, Educational Institution

When to Use

  • When lecturers create teaching materials using the git.nrw GitLab template with CI/CD automation.
  • When version control and peer review of teaching documents are required.
  • When publishing teaching materials as static websites via Jekyll or Hugo.
  • When accessibility and multimedia content support are needed.

When Not to Use

  • When GitLab or CI/CD setup is unavailable.
  • When versioning or automated publishing is not required.

Process

  1. Lecturer logs into git.nrw.
  2. Create a new project from the teaching document template.
  3. (Optional) Use static HTML generators like Jekyll or Hugo to create and publish the teaching document as a website.
  4. Fill the project with content.
  5. Save the teaching document as a draft.
  6. (Optional) The document is sent to reviewers for approval or change requests.
  7. Publish the teaching document.
  8. Link the teaching document in the course.

Requirements

People

  • Lecturers
  • Students
  • Reviewers
  • GitLab Administrators

Data Inputs

  • Teaching document templates
  • Multimedia assets
  • Course metadata

Tools & Systems

  • GitLab (git.nrw)
  • Jekyll/Hugo
  • GitLab CI/CD Pipeline

Policies & Compliance

  • GDPR
  • Institutional Security Policy

Risks & Mitigations

  • The teaching document could not be created, the system remains unchanged, the lecturer receives an error message and can repeat the process.

    • Notify stakeholders promptly
    • Provide manual fallback procedure

Getting Started

Prerequisites: Git access and configured tools/systems listed below.

  1. Prepare repository/template/content as needed
  2. Configure tooling, permissions, and integrations
  3. Run the workflow and review results

Resources

FAQ

How can teaching documents be published?

By using GitLab CI/CD pipelines and static site generators like Jekyll or Hugo.

Can multiple versions of a document be maintained?

Yes, version control is provided automatically through GitLab repositories.

Can documents include multimedia content?

Yes, templates support text, images, video, and other multimedia assets.

Glossary

GitLab Pages
Static website hosting service integrated with GitLab repositories.
Jekyll
Static site generator for building websites from Markdown or HTML templates.
Hugo
Fast static site generator written in Go for building websites.
CI/CD
Automated pipeline for building, testing, and deploying content.