Homework answers / question archive / Here are details about the 3 parts in the delivery: 1

Here are details about the 3 parts in the delivery: 1

Computer Science

Share With

---

Here are details about the 3 parts in the delivery:

1. Document describing the process and content/use of the solution (pdf)

This part consists of creating a short, written report documenting the project you have worked on.

Suggested length: minimum 1,500 to 2,000 words (3 to 4 regular-sized, line-spaced pages).

Items that should be included:

• The exam process: Write about how you have worked on the hand-in.

• Solution, challenges & fancy features: Describe what you made and why (including DB or file format and why this.) Tell about what you struggled with, and what you are particularly satisfied with.

• List of content from the syllabus: A short list of which elements from the syllabus you have included, and where/how they are used.

• Description of topics not seen in the code: Refactoring, pair programming, SOLID?, etc.

• Known bugs: Do you know of any errors in the program? If so, tell about them here.

• References, IMPORTANT: If it is discovered that you have used ready-made material that you do not disclose (do not mention here), it can be interpreted as cheating! Therefore, remember to state sources, we want to avoid cases of plagiarism!

Remember: Software design is as much about the development of a program as the finished program. Make sure you document both your solution and the process well!

2. Source code and any other necessary files in that context (zip)

This is the code implementation of the program. Provide the source code (and associated files), so that the assessor can see the programming and code structure! Note: Should be openable in Visual Studio 2022.

Remember: We have learned about modelling software solutions in this subject, through class and sequence diagrams in UML. Figures and other content you produce in that context should also be delivered here. It can be screenshots from digital tools, mobile photos of paper-based drawings, etc.

3. Executable (.exe) version, which can be started from Windows (zip)

The executable version should be usable on Windows 11. Make sure that both the .exe file and any necessary folders are included.

Solution design

This exam involves designing a software solution, then programming the software solution in C#.

Designing a software solution

When it comes to "designing a software solution", it means focusing on the code structure. Not user experience, not visual style, not the market aspect or anything else that does not fall under the syllabus of the course.

Programming the solution in C#

You are free to choose the business/domain logic the program will handle, as long as the solution covers the content for the standard 3-layer architecture:

• Data storage at the backend (storage to DB, JSON file or XML file).

• Domain logic in the middle.

• Console-based frontend. (Not much focus on the UI experience, it's not part of the

curriculum. But well-written frontend code is good.)

It is expected that the solution contains at least 2 projects:

• C#, Console App

• C#, NUnit Test Project

Make sure you get a good selection of elements from the syllabus! (See the section below.)

Syllabus, what should be included

Elements from the syllabus: (this is not a complete list, if your group considers using more/other elements from the syllabus, that is perfectly fine)

• UML diagrams.

• C# .NET, with features from the language: properties!, possibly operator overloading, …

• SOLID (describe through the documentation which principles you are focusing on).

• Design patterns (pick a few of the ones we've learned: trying to use them all = chaotic).

• Refactoring (ensure that the code is kept clear and easy to understand). Describe your

refactoring process, it can be difficult to see from the code.

• Layering

• Unit testing. Note: Writing enough unit tests to cover an entire solution is extensive. It is

therefore ok if you only use it on selected parts of the solution. But if so, describe what you

choose to test and why. Implement tests so that you can show the breadth of what you

know about unit testing.

• Multithreading / event-based code (in that case make sure you write thread-safe code).

• Pair programming. If so, describe how you use this, as well as the experiences you have had.

• Use of version control.

Note: If you do something that doesn't seem logical (because you want to show that you master a given part of the syllabus but can't find a perfect place to show it), explain why you have used it, both as a code comment and in your attached pdf document.