Lessons are the individual sections of a module. Each lesson is contained in its own folder, which is numbered and named after the lesson.
Lessons should be focused on a single topic or concept, and should be structured to help the learner understand and apply the material. Shorter lessons are better than longer ones.
Structure
Lesson files are named lesson.adoc and contain the content for the lesson.
The lesson.adoc file must contain:
-
A
:type: -
An
:order: -
A title (
= Heading) for the lesson -
A
read::or a question to complete the lesson -
A
[.summary]section to display when the lesson is completed
= Lesson Title
:type: lesson
:order: 1
Lesson content goes here.
== End of the lesson
read::Message to complete the course[]
[.summary]
== Summary
Congratulations on completing the lesson.Types
Lessons can have one of the following types:
-
lesson- a standard lesson -
challenge- a lessons that is a challenge or exercise -
video- a video lesson -
quiz- a quiz lesson
The type should describe the overall content of the lesson.
For example, if the lesson is primarily a video, it should be marked as video.
If a lesson is a list of questions, it should be marked as quiz.
If a lesson is a standard lesson, but it contains a single question, it should be marked as lesson.
Video
Not every lesson needs a video.
Video should be used in lessons when it is helpful to explain a concept, to demonstrate a complicated process, or build learners confidence. Video lessons should be short, ideally under 5 minutes, and should be used to supplement the course content.
A written version (transcript) of the video should be provided in the lesson content.
= Lesson Title
:type: video
:order: 1
In this lesson, you will ...
[.video]
== Video Lesson
video::a0L5iQiIO80[youtube,width=560,height=315]
[.transcript]
== Written Lesson
The written version of the video should contain the same content as the video, but in a written format.
== Other lesson content
This content will be shown at the end of the lesson.
read::Complete[]
[.summary]
== Summary
You have completed the video lesson.Summary
In this lesson, you learned about the structure of a lesson in GraphAcademy
In the next lesson, you will learn about GraphAcademy questions.