curriculum/challenges/english/blocks/learn-how-to-document-code-for-a-project/65ddb2ee481da72f38f076ad.md
Watch the video to understand the context of the upcoming lessons.
Watch the video
{
"setup": {
"background": "company2-center.png",
"characters": [
{
"character": "Sophie",
"position": { "x": -25, "y": 0, "z": 1 }
},
{
"character": "Brian",
"position": { "x": 125, "y": 0, "z": 1 }
}
],
"audio": {
"filename": "7.1-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": 4.94,
"dialogue": {
"text": "Hey, Brian, I've been assigned to work on this project, and I'm not sure where to start.",
"align": "left"
}
},
{
"character": "Sophie",
"startTime": 5.48,
"finishTime": 7.94,
"dialogue": {
"text": "Could you help me understand how we should document the code?",
"align": "left"
}
},
{
"character": "Brian",
"startTime": 8.5,
"finishTime": 13.96,
"dialogue": {
"text": "Of course. The first thing you should do is create a clear README file that's in the project's root directory.",
"align": "right"
}
},
{
"character": "Brian",
"startTime": 14.5,
"finishTime": 19.3,
"dialogue": {
"text": "This file should contain information about the project, its purpose, and how to set it up.",
"align": "right"
}
},
{
"character": "Sophie",
"startTime": 19.72,
"finishTime": 21.8,
"dialogue": {
"text": "Got it. What else should I include in my README?",
"align": "left"
}
},
{
"character": "Brian",
"startTime": 22.22,
"finishTime": 27.38,
"dialogue": {
"text": "You should list the project dependencies so that anyone who wants to work on it knows what they need.",
"align": "right"
}
},
{
"character": "Brian",
"startTime": 27.38,
"finishTime": 31.96,
"dialogue": {
"text": "Then specify how to run the code and any other essential setup instructions.",
"align": "right"
}
},
{
"character": "Brian",
"startTime": 33.04,
"finishTime": 35.96,
"dialogue": {
"text": "Also, mention coding conventions we follow in this project.",
"align": "right"
}
},
{
"character": "Sophie",
"startTime": 36.92,
"finishTime": 38.78,
"dialogue": {
"text": "Thanks, I'll make sure to follow your instructions.",
"align": "left"
}
},
{
"character": "Brian",
"position": { "x": 125, "y": 0, "z": 1 },
"startTime": 39.28
},
{
"character": "Sophie",
"position": { "x": -25, "y": 0, "z": 1 },
"startTime": 39.78
}
]
}