Back to Freecodecamp

Dialogue 1: Navigating Documentation

curriculum/challenges/english/blocks/learn-how-to-read-and-understand-code-documentation/65fd595245455d0dca3434ba.md

latest3.2 KB
Original Source

--description--

Watch the video to understand the context of the upcoming lessons.

--assignment--

Watch the video

--scene--

json
{
  "setup": {
    "background": "company2-breakroom.png",
    "characters": [
      {
        "character": "Tom",
        "position": { "x": -25, "y": 0, "z": 1 }
      },
      {
        "character": "Sarah",
        "position": { "x": 125, "y": 0, "z": 1 }
      }
    ],
    "audio": {
      "filename": "7.2-1.mp3",
      "startTime": 1
    },
    "alwaysShowDialogue": true
  },
  "commands": [
    {
      "character": "Tom",
      "position": { "x": 25, "y": 0, "z": 1 },
      "startTime": 0
    },
    {
      "character": "Sarah",
      "position": { "x": 70, "y": 0, "z": 1 },
      "startTime": 0.5
    },
    {
      "character": "Tom",
      "startTime": 1,
      "finishTime": 5.16,
      "dialogue": {
        "text": "I'm trying to understand the code documentation but it's quite overwhelming.",
        "align": "left"
      }
    },
    {
      "character": "Tom",
      "startTime": 5.16,
      "finishTime": 7.28,
      "dialogue": {
        "text": "What should I do to navigate it more effectively?",
        "align": "left"
      }
    },
    {
      "character": "Sarah",
      "startTime": 8,
      "finishTime": 10.74,
      "dialogue": {
        "text": "Don't worry. When you're faced with extensive documentation,",
        "align": "right"
      }
    },
    {
      "character": "Sarah",
      "startTime": 11.14,
      "finishTime": 14.66,
      "dialogue": {
        "text": "the first thing you should do is check for a table of contents or an index.",
        "align": "right"
      }
    },
    {
      "character": "Sarah",
      "startTime": 14.98,
      "finishTime": 17.94,
      "dialogue": {
        "text": "It can help you find the specific information you're looking for.",
        "align": "right"
      }
    },
    {
      "character": "Tom",
      "startTime": 18.28,
      "finishTime": 21.3,
      "dialogue": {
        "text": "Okay, that makes sense. And what should I do next?",
        "align": "left"
      }
    },
    {
      "character": "Sarah",
      "startTime": 21.88,
      "finishTime": 25.98,
      "dialogue": {
        "text": "Once you've found the section you need, you should start by reading the introductory paragraphs",
        "align": "right"
      }
    },
    {
      "character": "Sarah",
      "startTime": 25.98,
      "finishTime": 28.62,
      "dialogue": {
        "text": "to get an overview of what the documentation covers.",
        "align": "right"
      }
    },
    {
      "character": "Sarah",
      "startTime": 29.22,
      "finishTime": 32.88,
      "dialogue": {
        "text": "Then you can skim through and focus on the parts relevant to your current task.",
        "align": "right"
      }
    },
    {
      "character": "Tom",
      "startTime": 33.42,
      "finishTime": 36.16,
      "dialogue": {
        "text": "Thanks, I'll go over the documentation as you said.",
        "align": "left"
      }
    },
    {
      "character": "Sarah",
      "position": { "x": 125, "y": 0, "z": 1 },
      "startTime": 36.56
    },
    {
      "character": "Tom",
      "position": { "x": -25, "y": 0, "z": 1 },
      "startTime": 37.16
    }
  ]
}