Skip to content

Informational Standards

Description and Purpose

An informational's intended use is to provide context for learning throughout a course or Path. Informationals may appear in a variety of contexts, most commonly including (though not strictly limited to):

  • A welcome to provide contextual information (i.e., how a particular module relates to a larger course or Path), learning outcomes, and/or expectations for the upcoming course or Path.
  • Community or cohort resources for a career path.
  • Pair programming opportunities in a career path.
  • Code Review opportunities in a career path.
  • Group project opportunities in a career path.
  • Next steps following completion of a course or Path
  • Helpful resources

Informationals should NOT be used to introduce new concepts or code or be used to check for understanding.

Content Location

Informationals, like other content items, exist inside of modules. The placement of the module within its track varies by informational type.

For example, a Welcome informational should be added in its own module as the first module in its track. Meanwhile, a Next Steps informational should be added in its own module as the last module in its track.

Overarching Standards

Fields in Author

Content

Informational Text

The informational text is displayed to learners as the body of the informational.

  • The informational text is intended to contextualize other content contained within the same container and provide resources. It is not intended to introduce new material or assess learner knowledge.
  • This field supports Markdown syntax and may contain:
    • text
    • code blocks
    • embedded images and videos
    • links to other resources

Description

The description provides a brief description of the contents of the informational. It is surfaced to learners as a subheader directly below the title of the informational.

  • The description should include key terms when appropriate (for SEO purposes).

Attributes

Title

The title is displayed to learners at the top of the narrative in the LE and in the course menu.

  • Titles should include key terms when appropriate (for SEO purposes).

Slug

The slug is used to create a URL for the content item. It is auto-generated based on the Title field though it can be edited.

Minutes to Complete

This field is an estimation of how long the content item and any embedded elements will take to complete.

  • Most individuals read at around 250 words per minute, so this can be used as a proxy while you estimate time to complete. When in doubt, air on the side of being conservative — so make a longer estimate rather than a shorter one.

Credited Authors

  • 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.

Access Control

This field determines which user group can access the content. This content is Codecademy Pro-only content by default.

  • Consult with your production team to see whether you should toggle the content to Free.

Examples