Description and Purpose
Modules are the content containers that hold the content items learners interact with. Modules are the basic building blocks of courses and tracks within a Path. Think of courses or paths like books, and the modules are the chapters in these books. For example, the Learn Python 3 course contains multiple modules like Functions, Control Flow, Classes and Objects, and String Methods.
Modules typically follow the “5 Step” (“5S”) pedagogical framework: Hook, Introduction to New Material, Guided Practice, Independent Practice, and Evaluation. At their smallest, modules are often structured to contain at least 1 lesson (Hook, Introduction to New Material, Guided Practice), 1 project (Independent Practice) and 1 quiz (Evaluation).
The size of a module is flexible, but generally, the objective of a module is to ensure that students learn a new concept, practice their knowledge, and, by the end, assess their understanding.
Modules are the smallest level of containers for content items. They organize the content items that learners will interact with: lessons, quizzes, projects, articles, informationals, or external resources.
Modules themselves are arranged within Tracks to create courses or Paths and are visible in the Overview and Syllabus landing pages for courses and Paths as well as in the course menu of the LE.
- All content is written in Markdown and adheres to Codecademy’s Markdown Style Guide.
- All content adheres to Codecademy's Editorial and Pedagogy standards
- Content adheres to Codecademy’s Diversity, Equity, Inclusion, & Accessibility standards.
- All work is original. Sources are cited via links or, for datasets, by following the Dataset Guidelines.
Fields in Author
Content Item List
The Content Item List field is where you choose the content items (lessons, quizzes, projects, etc.) you want to include in this module.
- Click on the "Add +" button to open the sidebar where you can search for content items by name or by content item ID.
- For example, the content item ID
c3a1bf21c7407e8f7a67b74533a1616c can be used to search for the content item Introduction to Numpy Quiz
- Selecting a content item from the search results list will add it to the Content Item List.
- Keep in mind that order matters, and items will be presented to users in the order specified here. You may drag and drop items in the desired order.
- Hover over a content item to reveal additional options:
- You may remove a content item from the Content Item List (this does not destroy the content item in Author).
- You may open the Author page for the content item in a new window.
- You may preview the content item as the learner would experience it.
Catalog Card Description
This field is the short description shown for a module in the Codecademy course catalogs.
- Catalog card descriptions are limited to 140 characters.
Landing Page Description [To Be Deprecated]
A module’s landing page includes information about the contents and purpose of the module.
- Information on the landing page should motivate learners about the content and help them understand if this content is appropriate for them to engage with.
The title is displayed to learners at the top of the article in the LE and in the course menu.
- Titles should include key terms when appropriate (for SEO purposes.)
The slug is used to create a URI for the content item.
- The slug is auto-generated based on the Title field though it can be edited.
This field allows you to add an associated author(s) to the item. For now, this field is not publicly visible, but is helpful as a reference.
Containers That Use This Module
This field is autogenerated and will populate all containers that contain this module.
- Introduction to Numpy - This module is a typical 1-1-1 module (1 lesson, 1 quiz, 1 project). Note that the landing page and catalog card description are the same. This is common for modules.
- Deploy a Site with GitHub Pages - This module is in a Career Path and contains an article linking to external content as well as a tutorial article.
- Code Review: Dasmoto's Arts & Crafts - This module is used within a Career Path and contains a single informational guiding learners to review their peers' work.