Back to Freecodecamp

Dialogue 1: Analyzing API Documentation

curriculum/challenges/english/blocks/learn-how-to-analyze-code-documentation/6606682f3fbb93838673920d.md

latest2.7 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": "Sophie",
        "position": { "x": -25, "y": 0, "z": 1 }
      },
      {
        "character": "Brian",
        "position": { "x": 125, "y": 0, "z": 1 }
      }
    ],
    "audio": {
      "filename": "7.3-1.mp3",
      "startTime": 1
    },
    "alwaysShowDialogue": true
  },
  "commands": [
    {
      "character": "Sophie",
      "position": { "x": 25, "y": 0, "z": 1 },
      "startTime": 0
    },
    {
      "character": "Brian",
      "position": { "x": 70, "y": 0, "z": 1 },
      "startTime": 0.5
    },
    {
      "character": "Sophie",
      "startTime": 1,
      "finishTime": 5.38,
      "dialogue": {
        "text": "I'm working with a new API and I'm not sure how to analyze its documentation effectively.",
        "align": "left"
      }
    },
    {
      "character": "Sophie",
      "startTime": 5.84,
      "finishTime": 7.48,
      "dialogue": {
        "text": "What's the right approach in your opinion?",
        "align": "left"
      }
    },
    {
      "character": "Brian",
      "startTime": 8.16,
      "finishTime": 12.08,
      "dialogue": {
        "text": "You should begin by checking the endpoints and the routes provided in the documentation.",
        "align": "right"
      }
    },
    {
      "character": "Brian",
      "startTime": 12.42,
      "finishTime": 15.26,
      "dialogue": {
        "text": "This can give you a clear idea of what the API offers.",
        "align": "right"
      }
    },
    {
      "character": "Sophie",
      "startTime": 15.96,
      "finishTime": 17.36,
      "dialogue": {
        "text": "Okay, and what should I do next?",
        "align": "left"
      }
    },
    {
      "character": "Brian",
      "startTime": 17.84,
      "finishTime": 22.04,
      "dialogue": {
        "text": "Once you've identified the endpoints, read the descriptions and examples for each one.",
        "align": "right"
      }
    },
    {
      "character": "Brian",
      "startTime": 22.38,
      "finishTime": 25.5,
      "dialogue": {
        "text": "This can help you understand how to use the API in your project.",
        "align": "right"
      }
    },
    {
      "character": "Sophie",
      "startTime": 26.06,
      "finishTime": 27.28,
      "dialogue": {
        "text": "Thanks, I'll give it a shot.",
        "align": "left"
      }
    },
    {
      "character": "Brian",
      "position": { "x": 125, "y": 0, "z": 1 },
      "startTime": 27.78
    },
    {
      "character": "Sophie",
      "position": { "x": -25, "y": 0, "z": 1 },
      "startTime": 28.28
    }
  ]
}