Back to Freecodecamp

Task 21

curriculum/challenges/english/blocks/learn-how-to-document-code-for-a-project/65e8677731fef734895ac330.md

latest2.5 KB
Original Source
<!-- (Audio) Brian: You should list the project dependencies so that anyone who wants to work on it knows what they need. Then specify how to run the code and any other essential setup instructions. Also, mention coding conventions we follow in this project. -->

--description--

Listen to the audio and answer the question.

--questions--

--text--

What are the things Brian instructs Sophie to do for the project?

--answers--

List team members and their roles

--feedback--

Brian's instructions are about technical aspects of the project, not about listing team members and their roles.


List project dependencies, specify how to run the code, and mention coding conventions


Write a report on the project's progress

--feedback--

Writing a progress report isn't mentioned in Brian's instructions, which are more focused on technical setup and standards.


Create a new software tool

--feedback--

Brian's focus is on documenting existing aspects of the project, not creating new tools.

--video-solution--

2

--scene--

json
{
  "setup": {
    "background": "company2-center.png",
    "characters": [
      {
        "character": "Brian",
        "position": {
          "x": 50,
          "y": 15,
          "z": 1.2
        },
        "opacity": 0
      }
    ],
    "audio": {
      "filename": "7.1-1.mp3",
      "startTime": 1,
      "startTimestamp": 21.22,
      "finishTimestamp": 34.96
    }
  },
  "commands": [
    {
      "character": "Brian",
      "opacity": 1,
      "startTime": 0
    },
    {
      "character": "Brian",
      "startTime": 1,
      "finishTime": 3.12,
      "dialogue": {
        "text": "You should list the project dependencies",
        "align": "center"
      }
    },
    {
      "character": "Brian",
      "startTime": 3.12,
      "finishTime": 6.16,
      "dialogue": {
        "text": "so that anyone who wants to work on it knows what they need.",
        "align": "center"
      }
    },
    {
      "character": "Brian",
      "startTime": 6.16,
      "finishTime": 10.74,
      "dialogue": {
        "text": "Then specify how to run the code and any other essential setup instructions.",
        "align": "center"
      }
    },
    {
      "character": "Brian",
      "startTime": 11.82,
      "finishTime": 14.74,
      "dialogue": {
        "text": "Also, mention coding conventions we follow in this project.",
        "align": "center"
      }
    },
    {
      "character": "Brian",
      "opacity": 0,
      "startTime": 15.24
    }
  ]
}