Review Card Standards
Description and Purpose
A Review Card is presented to learners to help them review a learning standard they encountered in the associated module. Review cards contain two elements: a text block and a code/image block. The text should fully describe the learning standard and the code or image should show an example of the concept covered by the learning standard.
Review cards have a one-to-one relationship with learning standards. A review card’s linked learning standards are used to associate them to the relevant Practice Packs and Cheat Sheets.
Review Cards are presented to a learner as part of Practice Packs that they can engage with on the web or on the mobile app. These packs contain a variety of assessments and review cards that are aligned with the learning standards from the module the learner most recently completed.
Review cards are also presented in the product feature Cheat Sheets. These present the learner with a view of all of the review cards associated with a module.
- 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
The review text is the main body of the review card.
- Content in review text should be under 75 words.
- Use the same terminology and syntax as covered in the preceding lesson(s).
- Do not introduce any new material or syntax in a review card.
- Review cards with code blocks or an image should contain review text that directly supports the code example or image. When referencing the code or image, avoid directional language (“above,” “below,” “to the right”).
Example media provides additional media to complement the review card. It is optional.
Media Type Drop Down
- None: Select this if no additional media is necessary.
- Code Block: Supports the review card concept with a code example.
- Code inside the code blocks should use descriptive variable names that support the review card concept.
- Code inside the code blocks should be tested to ensure that it will run correctly.
- Additional Code Block Fields:
- Language Dropdown: Select the language that the code will be in.
- Code Block: Container for the review card code example.
- Image: Supports the review card concept with an image.
- Any images in a review card should have dark text/details. Review cards in the product have a white/light colored background.
- Images should be a screen capture or be sourced from free-to-use image sites like Unsplash.
- Image should be hosted on https://static-assets.codecademy.com.
- Image alt text that should follow the guidelines in the diversity, equity, inclusion, & accessibility standards.
- Additional Image Fields:
- Image URL: The URL for the image
- Alt Text: The written text that appears in place of an image on a webpage if the image fails to load on a user's screen. This text helps screen-reading tools describe images to visually impaired readers and allows search engines to better crawl and rank your website.
- Preview: This field is automatically generated. Its contents are generated from the URL in the Image URL Field.
The title is displayed to learners as part of a list of review cards in a cheatsheet or practice pack as well as at the top of each individual review card.
- The title of the review card should be no more than four (4) words long.
- The title is formatted in title case.
- The title references the code language, and all code is wrapped in single backticks (`).
- Titles should include key terms relevant to the learning standard. When able, try to use more SEO-friendly keywords.
The slug is used to create a URI for the content item. The slug is initially auto-generated based on the Title field.
- The slug of the review card starts with the language. i.e.
Learning Standards List
The review card should be linked to the associated learning standard. Review cards are grouped into practice packs through the learning standards linked to a modules content items (i.e. Lessons, Quiz Assessments, Articles).
- There is a one-to-one relationship between review cards and learning standards. Each review card is aligned with a single learning standard and there is only one review card per learning standard.
- Learn SQL: AS Review Card uses common language and describes the outcome of the example code.
- Data Structures and Algorithms: Bubblesort Review Card