Skip to content

Portfolio/Kanban Standards

Description and Purpose

Portfolio/Kanban Projects are the most challenging projects that we offer in our curriculum. They require learners to build the project off-platform and publish that project so that it can be shared with others. Portfolio/Kanban Projects are an opportunity for learners to prove their mastery of the subject.

Portfolio/Kanban Projects are presented as a Kanban board listing the different tasks in cards to accomplish a certain goal. When clicked on, each card will have more information and (optionally) a hint on how to achieve this task. Learners will be able to move the cards through the "In Progress'' and "Done" phases as they work on the different tasks. Learner progress on the board will be saved.

GIF of Kanban board showing a card being opened and then dragged to different phases

Content Location

Portfolio/Kanban Projects can be found in Skill Paths and Career Paths. In Skill Paths they are found at the end of the Path (what used to be known as "Capstone Projects"). In Career Paths, they occur at the end of every "Skill Path" amount of content, usually an average of 3-5 per Career Path, depending on its length.

Each Portfolio/Kanban Project lives in its own Module, in its own Track. If there is an option to choose between projects, each project will live in its own Module, and the collection of Projects will live in its own Track. With multiple projects, the Curriculum Developer should note if they are all required or only one is required. However, it must be noted that if they do not complete all included projects then they will not have 100% path completion.

Overarching Standards

Fields in Author

Content

Description

The description should provide a brief summary of what the project covers. Descriptions are indexed by Google search as well as ElasticSearch, so they can be used to find content via search engines, Author, or Codecademy’s search functionality. Descriptions also appear on cards in the project library on the Codecademy site, but in a truncated form.

  • Descriptions may appear truncated in certain locations, so frontload important information. Cut filler like “In this project, you will…”
  • Keep descriptions short. Aim for 1 - 2 short sentences or around 30 words.
  • Focus on the outcome. What will the learner do or build?
  • Include frameworks or skills learners will practice in the project when appropriate.
  • Include key terms when appropriate (for SEO purposes).

Examples: - Utilize the Django framework to create an app that helps track a restaurant’s inventory and sales. - Build a style guide for your web projects, including custom fonts, colors, text styles, and more. - Write an interactive Choose Your Own Adventure game using the Tree data structure. - Use decision trees to predict what continent a flag comes from based on features like color and shape.

Short Overview

A 2-3 sentence description for learners who are about to start the project. This is only shown once to learners in an interstitial (the page displayed to learners before they enter the project). This overview is to help frame and contextualize the project and introduce learners to what they will be doing.

Project Toolkit

The main markdown fields of the project. These will be available to learners to reference alongside the individual requirements as the complete the project.

Each field has a different meaning and individual formatting guidelines.

Use h3 and smaller headings if you need them, there will already be an h2 for this section.

Long Overview

In-context summary of the project to be used as a reference as learners complete the individual requirements. Since learners cannot return to the short overview, anything mentioned there should be reiterated in this long overview section. This is the default display along with the kanban board and cards. This overview should help learners keep the goals of the project in mind and stay on track with each of their steps.

Solution code can also be made available here for learners to download.

Setup Instructions

Instructions for learners in order to be able to start the project. This can include environment setup tutorials, editor installation instructions, or any other information necessary for learners to develop on their own computer. If there is starter code for learners, include it in this section.

Resources

Resources for learners to refer to as they complete the project or after completion.

Resources can include:

  • Debugging tips
  • Debugging resources, each with a title and link
  • Example code
  • Walkthrough video

Kanban Tasks

Each Kanban task should be a concise, high-level description of a single project stage. Kanban boards are meant to provide visual cues to spark action, and as such, are most effective when the discrete steps are described with action verbs. This may not always be possible, but each task should be focused on the action rather than the outcome. For example, "create a github repository" is better than "github repository."

Because learners should be independent at this point, tasks should be at a high level, so "create github repository" is appropriate whereas "sign up for github" is too granular.

Kanban Task Title

A 1-5 word description of the task. Lead with an action verb. Learners should be able to glance at this title and remember what to do.

Kanban Task Description

A 1-3 sentence description of what a learner should do at a high level. Because it is a portfolio project, this should be outcomes oriented rather than prescriptive. What should they do, make, or have by the end of this step?

Kanban Task Hint

A 1-3 sentence hint that gives learners a push in the right direction. This could include:

  • A helpful tip to improve workflow
  • A suggestion if the task has a creative aspect
  • Reminding learners of a common pitfall with this task
  • A link to a relevant lesson
  • A link to a cheatsheet

Attributes

Title

The title of the project. Do not include the word 'project' in the title.

Hours to Complete

This field should be how long you think the project and any embedded elements will take to complete.

  • Consider how long each step should take. This field should be the sum of all those tasks, generously estimated as learners may be doing each step on their own for the first time.

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.

Linked Content

Learning Standards List (To Be Deprecated)

Kanban projects typically do not have learning standards since they themselves are meant to assess what has been learned in the entire path.

Containers That Use This Kanban Project

This field is auto-generated and will populate any containers that contain this quiz.

Examples