Skip to content

Latest commit

 

History

History
37 lines (24 loc) · 3.57 KB

DESIGN.md

File metadata and controls

37 lines (24 loc) · 3.57 KB

Design

In this milestone, you will write a proposal with a high-level architecture design and design sketches for your course project. That is, your design may change from the initial proposal after beginning the implementation and bad proposals may be rejected by the professor. Make sure to spend time in coming up with a good project idea and brainstorm good designs.

Architecture Design

You will need to provide a high-level design overview on the architecture of your project in a design section of your proposal. This section must include the following information:

  • Describe the different architectural components and how they would fit together.
  • Describe any constraints or guidelines that should be established in building software for your architecture.
  • Describe any additional design patterns that may be relevant for your bot design.

This is the opportunity to initially think through how you might build your system to fulfill your requirements and provide a solution to the problem statement. Consider all the criteria listed here in your design proposal description.

Design Sketches

Design sketches provide a visual overview of the look and feel of your project. This may include one of the following:

  • Creating a wireframe mockup of your project user interface in action.
  • Create a storyboard that illustrates a primary task that a user would complete with your project.

The design sketches may be included as part of your design proposal document or can be submitted separately.

Research-based projects should focus on the research problem and study design. Design sketches should depict interactions for participants in your study.

Deliverable: Proposal Document

  • Your project team must also submit a design proposal document. The proposal must conform to the International Conference on Software Engineering (ICSE) formatting guidelines (see the MS Word, Latex, and Overleaf templates). The two-column format is also acceptable (Overleaf). The proposal must introduce your project and provide an overview of the high-level design. Your document should be no more than 2-pages (excluding references and design sketches). Please check your document for typos and spelling or grammar errors. The proposal must contain:
    • a relevant title and all group members listed as authors;
    • an abstract briefly describing the problem and proposed solution;
    • an introduction that further explains the problem and motivates the need for the proposed solution;
    • related work presenting relevant software engineering studies or tools;
    • a brief description of the high-level architectural design of the proposed work (how different parts of the system work together);
    • and references to any appropriate citations.
    • In addition to the design section of the proposal document, you must provide a design sketch (can be a wireframe, prototype, storyboard, flow map, text description, etc.) for the user interface of your project. This may be included in the document or submitted separately.

Due: Friday February 17 at 11:59pm on Canvas