scaffold-spec.md

scaffold function

scaffold should be a function that takes in two inputs:

• topicHierarchy
• scaffoldSpec

Inputs

topicHierarchy

{
  {
    <major topic : String>: [
      <minor topic : String>
      <minor topic : String>
      <minor topic : String>
      <minor topic : String>
      <minor topic : String>
    ]
  },
  {
    <major topic : String>: [
      <minor topic : String>
      <minor topic : String>
      <minor topic : String>
      <minor topic : String>
      <minor topic : String>
    ]
  },
}

scaffoldSpec

Somehow specify the structural constraints for the scaffold (see below). Start without this input and hard core the PBL constraints into the scaffold funtion. Once you get this working, then you can try and refactor for a topicHiearchy input to make scaffolding functionality customizable.

Returns

[
  // each of these objects specifies a Unit
  {
    name: String,
    materials: [
      // each of these objects is a Material of some type
      {
        name: <String>,
        type: <String>,
        content: <String>
      },
      {
        name: <String>,
        type: <String>,
        content: <String>
      }
    ]
  },
  {
    name: String,
    materials: [
      {
        name: <String>,
        type: <String>,
        content: <String>
      },
      {
        name: <String>,
        type: <String>,
        content: <String>
      }
    ]
  },
]

Our notes about constraints for a scaffold

Note: order of applying constraints does matter! Do not try and replicate all of the complexity of this, just use it as general guidelines / reference for logic we have already worked out

Topic-hierarchy based

[X (integer)] [Insertion Course Element] per [topic level] (Course Element Template)

1. Unit per topic (Unit template X)
2. Exam per topic (Exam template X)
3. Project per topic (Project template X)
4. Lesson per subtopic (Lesson template X)
5. Coursework per subtopic (Coursework template X)

Skeleton-structure based

[X (integer)] [Insertion Course Element] [relative location][general ordinal] [Existing Course Element] ([Course Element Template])

1. Feedback @ end of each Unit (Feedback Template X)
2. Self-assessment @ end of each Unit (Self-Assessment Template X)
3. Feedback @ end of each Project (Feedback Template X)
4. Self-assessment @ end of last Project (Self-Assessment Template X)
5. Self-assessment before each Lesson (Self-Assessment Template X)
6. Unit @ end of Course
7. Project in last Unit