Skip to main content

Guidelines on How to Write Assignments

Your blueprint for writing high-quality, professional assignments in the Prodigal AI Training Program.

Index​

  • Overview of Deliverables
  • Core Content of the Assignment
  • How to Structure Your Document
  • How to Answer Questions and Explain Your Content
  • Code Block Examples

Overview of Deliverables​

Assignments should be submitted in a clean, readable format using Markdown. Ensure the content is well-structured, concise, and visually clear.

Core Content of the Assignment​

Format Guidelines​

  • Use Markdown for all assignments. Notion is preferred for its ease of use and formatting features.

  • Maintain a strong hierarchy of information:

    • Use headings like #, ##, ### appropriately.
    • Use bullet points, numbered lists, and blockquotes to format content.

This is a quote example (>)

  • Bullet Point Example (* or -)

    • Sub-bulleted item (tab + * or -)
  1. Numbered list example (number. - so for number 1, we use 1.)

Callout Sections​

Use callouts to highlight important terms, explanations, or instructions. These are technically just quotes with a title to them like naming it "Callout" below:

Callout: This section is very important!

Image Guidelines​

  • Clearly annotate screenshots — show exactly what’s being clicked or interacted with.
  • Blur any sensitive content and highlight key areas of interest.
  • Preferred tool: ShareX for capturing and editing screenshots.

Use of Colors​

Use color sparingly and purposefully to emphasize key points in your text.

How to Answer Questions and Explain Your Content​

What Not to Do​

  • Do not copy-paste answers from ChatGPT, Claude, or any other LLM.
  • Don’t overuse emojis or hyperlinks.
  • Don’t paste raw code into text without proper formatting.

What You Should Do​

  • Keep answers concise and to the point.
  • Support answers with:
    • Diagrams
    • Examples
    • Screenshots
  • Use proper code blocks when including code samples:

Code Block Examples​

Use triple backticks (```) followed by the language name for proper syntax highlighting.

Python​

def greet(name):
    return f"Hello, {name}!"

JavaScript​

function greet(name) {
    return `Hello, ${name}!`;
}

HTML​

<!DOCTYPE html>
<html>
<head><title>Hello</title></head>
<body>
  <h1>Hello, world!</h1>
</body>
</html>

Bash​

#!/bin/bash
echo "Hello, world!"

SQL​

SELECT * FROM students WHERE enrolled = TRUE;

JSON​

{
  "name": "Prodigal AI",
  "status": "active"
}

By following this structure, you'll ensure that your assignment is professional, clear, and impactful.