Skip to content

A1: Requirements

Project Documentation and Requirements
Week 1 Assignment – Due 1/16/2024 – Beginning of Class
75 points

Overview:
In this assignment, you will begin the foundational work for your Python application project. The focus is on understanding and documenting the requirements of your application. You are expected to produce three key documents: a Project Proposal, a Requirements Specification Document, and a set of User Stories or Use Cases. These documents will serve as the blueprint for your application development throughout this course.

Objectives:
  • Develop a clear understanding of the project’s goals and functionalities.
  • Learn to articulate and document software requirements effectively.
  • Lay the groundwork for the design and development phases of your project.

Deliverables:
  1. Project Proposal or Concept Document
    • Description: Provide an overview of your proposed application. This should include the purpose of the application, its target audience, and a high-level description of its functionalities.
    • Length: 1-2 pages.
  2. Requirements Specification Document
    • Description: Detail all functional and non-functional requirements of your application. Functional requirements should describe specific actions or processes (e.g., user authentication, data processing). Non-functional requirements should cover aspects like performance, security, and usability.
    • Length: 2-4 pages.
  3. User Stories or Use Cases
    • Description: Create a series of user stories or use cases that illustrate how end-users will interact with your application. Each story or case should clearly outline a user goal and the steps to achieve it.
    • Format: For User Stories, use the template: “As a [type of user], I want [an action] so that [a benefit/value].” For Use Cases, provide a step-by-step narrative.
    • Quantity: At least 5 User Stories or 3 Use Cases.

Submission Guidelines:
  • Submit all documents in a single PDF file.
  • Ensure that each document is clearly labeled and separated within the PDF.
  • Use a standard 12-point font, double-spaced, for all text.
  • Include your name, student ID, and date on the cover page.

Evaluation Criteria (75 points):
  • Clarity and completeness of the Project Proposal.
  • Detail and accuracy in the Requirements Specification Document.
  • Relevance and practicality of User Stories or Use Cases.
  • Overall organization and presentation of the assignment.