Understanding the Assignment Documents

Understanding the Assignment Documents

This repository contains several documents because each serves a different purpose in the development process.

Assignment Guidelines and Rubric

The Module Three Assignment Guidelines and Rubric in D2L Brightspace is the official source for:

• Assignment requirements
• Grading criteria
• Required file formats
• Submission requirements
• Current AI-use guidance

Read it before the repository documents and return to it before submitting.

Software Requirements Specification (SRS)

File:

analysis/paycheck_calculator_srs.md

The SRS reorganizes the stated problem into requirements and acceptance conditions. It helps answer:

What must the solution do?

Do not edit the provided SRS.

Software Design Document (SDD)

File:

design/paycheck_calculator_sdd.md

The SDD explains design goals, constraints, and consistency checks without supplying a finished solution. It helps answer:

What must my design make clear?

Do not edit the provided SDD.

Software Development Worksheet (SDW)

File:

paycheck_calculator_sdw.md

The SDW is optional working space for brief notes while you move through the SDLC. It is not a graded deliverable.

You may edit it.

Flowchart Template

File:

design/paycheck_calculator.drawio

This is a graded deliverable. The template contains a Paycheck Calculator work page plus reference tabs for instructions, symbols, snippets, and sources.

You must edit this file to create your own flowchart.

Pseudocode Template

File:

design/paycheck_calculator.pseudo

This is a graded deliverable. Replace the TODO: prompts with your own pseudocode while keeping the required .pseudo file format.

Optional Python Starter

File:

src/paycheck_calculator.py

This file supports optional Construct-phase practice. It is not a graded Module Three deliverable.

Optional Tests

File:

tests/test_paycheck_calculator.py

The test script supports optional Test-phase practice. Leave the provided test file unchanged and use it only after completing the optional Python program.

Which Files Should I Change?

For the graded assignment, change only:

• design/paycheck_calculator.drawio
• design/paycheck_calculator.pseudo

You may also change:

• paycheck_calculator_sdw.md for working notes
• src/paycheck_calculator.py for optional practice

Leave the other provided files unchanged unless your instructor directs you otherwise.