edg3/experiment_software_csharp_12_net_8 · Datasets at Hugging Face

title stringlengths 3 46	content stringlengths 0 1.6k
21:24
21:25	Destination expert view:
21:26	The same view as the common user view
21:27	Answer questions asking for your destination expertise
21:28	Manage the points you scored by answering questions
21:29	Exchange points for tickets
21:30
21:31
21:32	Administrator view:
21:33	Manage packages
21:34	Manage common users
21:35	Manage destination experts
21:36
21:37
21:38
21:39	Besides the functionalities asked for on the platform, it is important to note that WWTravelClub intends to have more than 100 destination experts per package and will offer around 1,000 different packages all over the world.
21:40	It is important to know that, in general, customers do not bring the requirements ready for development. That is why the process of gathering requirements is so important, as described in Chapter 1, Understanding the Importance of Software Architecture. This process will transform the list presented above into user needs and system requirements. Let’s check how this will work in the next section.
21:41	User needs and system requirements
21:42	As presented in Chapter 1, Understanding the Importance of Software Architecture, to summarize the user needs, you may use the User Story pattern. We have used this approach here so that you can read the following user stories for WWTravelClub:
21:43
21:44	US_001: As a common user, I want to view promotional packages on the home page so that I can easily find my next vacation.
21:45	US_002: As a common user, I want to search for packages I cannot find on the home page so that I can explore other trip opportunities.
21:46	US_003: As a common user, I want to see the details of a package so that I can decide which package to buy.
21:47	US_004: As a common user, I want to register myself so that I can start buying the package.
21:48	US_005: As a registered user, I want to process the payment so that I can buy a package.
21:49	US_006: As a registered user, I want to buy a package with an expert recommendation included so that I can have an exclusive trip experience.
21:50	US_007: As a registered user, I want to ask for an expert so that I can find out the best things to do on my trip.
21:51	US_008: As a registered user, I want to comment on my experience so that I can give feedback on my trip.
21:52	US_009: As a registered user, I want to review an expert who has helped me so that I can share with others how fantastic they were.
21:53	US_010: As a registered user, I want to register as a destination expert view so that I can help people who travel to my city.
21:54	US_011: As an expert user, I want to answer questions about my city so that I can score points to be exchanged in the future.
21:55	US_012: As an expert user, I want to exchange points for tickets so that I can travel around the world more.
21:56	US_013: As an administrator user, I want to manage packages so that users can have fantastic opportunities to travel.
21:57	US_014: As an administrator user, I want to manage registered users so that WWTravelClub can guarantee good service quality.
21:58	US_015: As an administrator user, I want to manage expert users so that all the questions regarding our destinations are answered.
21:59	US_016: As an administrator user, I want to offer more than 1,000 packages around the world so that different countries can experience the WWTravelClub service.
21:60	US_017: As the CEO, I want to have more than 1,000 users simultaneously accessing the website so that the business can scale effectively.
21:61	US_018: As a user, I want to access WWTravelClub in my native language so that I can easily understand the package offered.
21:62	US_019: As a user, I want to access WWTravelClub in the Chrome, Firefox, and Edge web browsers so that I can use the web browser of my preference.
21:63	US_020: As a user, I want to know that my credit card information is stored securely, so I can buy packages safely.
21:64	US_021: As a user, I want to get a recommendation of a good place to visit according to other people from my city, so I can find out about new places that fit my style.
21:65
21:66	Notice that while writing the stories, information related to non-functional requirements such as security, environment, performance, and scalability can be included.
21:67	However, some system requirements may be omitted when you write user stories and need to be included in the software specification. These requirements can be related to legal aspects, hardware, and software prerequisites, or even points of attention for the correct system delivery. We discussed them in Chapter 2, Non-Functional Requirements. So non-functional requirements need to be mapped and listed, as well as the user stories. The WWTravelClub system requirements are presented in the following list. Note that requirements are written in the future tense because the system does not exist yet:
21:68
21:69	SR_001: The system shall use cloud computing components to deliver the scalability required.
21:70	SR_002: The system shall respect General Data Protection Regulation (GDPR) requirements.
21:71	SR_003: Any web page of this system shall respond within at least 2 seconds of 1,000 users accessing it concurrently.
21:72
21:73	The idea of having this list of user stories and system requirements is to help you understand how complex the development of a platform might be if you think about it from an architectural perspective.
21:74	Now that we have the list of user stories for the platform, it is time to start selecting the .NET project types that will be used at WWTravelClub. Let’s check them in the next topic.
21:75	Main types of .NET projects used at WWTravelClub
21:76	The development of this book’s use case will be based on various kinds of .NET Core Visual Studio projects. This section describes all of them. Let us select New project in the Visual Studio File menu.
21:77	For instance, you can filter .NET Core project types by typing them into the search engine as follows:
21:78
21:79	Figure 21.1: Searching types of .NET Core projects in Visual Studio
21:80	There, you will find common C# projects (console, a class library, Windows Forms, and WPF), and various types of test projects, each based on a different test framework: xUnit, NUnit, and MSTest. Choosing among the various testing frameworks is just a matter of preference since they all offer comparable features. Adding tests to each piece of software that composes a solution is a common practice and allows the software to be modified frequently without jeopardizing its reliability.
21:81	You may also want to define your class library projects under .NET Standard, which was discussed in Chapter 5, Implementing Code Reusability in C# 12. These class libraries are based on standards that make them compatible with several .NET versions. For instance, libraries based on 2.0 standards are compatible with all .NET Core versions greater than or equal to 2.0, with all .NET versions greater than 5, and with all .NET Framework versions greater than 4.6. This compatibility advantage comes at the price of having fewer available features.
21:82	Besides filtering project types to the cloud, we have several more project types. Some of them will enable us to define microservices. Microservice-based architectures allow an application to be split into several independent microservices. Several instances of the same microservice can be created and distributed across several machines to fine-tune the performance of each application part. If you want to learn about microservices, we have talked about them in the following chapters:
21:83
21:84	Chapter 11, Applying a Microservice Architecture to Your Enterprise Application
21:85	Chapter 14, Implementing Microservices with .NET
21:86	Chapter 20, Kubernetes
21:87
21:88	In Chapter 2, Non-Functional Requirements, we described an ASP.NET Core application project in the subsection Creating a scalable web app with .NET 8. There, we defined an ASP.NET Core application, but Visual Studio also contains project templates for projects based on RESTful APIs and the most important single-page application frameworks, such as Angular, React, Vue.js, and the Blazor framework based on WebAssembly, which was discussed in Chapter 19, Client Frameworks: Blazor. Some of them are available with the standard Visual Studio installation, while others require the installation of an SPA package, called ASP.NET and web development workload.
21:89
21:90	To finish, testing projects were discussed in detail in Chapter 9, Testing Your Enterprise Application. We suggest you, as a software architect, try all the templates available at Visual Studio by creating proofs of concept that may help you define the best project types for your solution.
21:91
21:92	Now that we have checked these different project types, let’s have a look at Azure DevOps and how it can be helpful in managing WWTravelClub is requirements.
21:93	Managing WWTravelClub’s requirements using Azure DevOps
21:94	As discussed in Chapter 3, Managing Requirements, an important step for a software development project is where and how the team will organize the user stories mapped from the user needs. There, as described in the Managing system requirements in Azure DevOps section, Azure DevOps enables you to document system requirements using work items, which are mainly tasks or actions that need to be completed to deliver a product or service.
21:95	It is also important to remember that the work items available depend on the work item process you select while creating the Azure DevOps project.
21:96	Considering the scenario described for WWTravelClub, we decided to use the Agile process and have defined three Epic work items as follows:
21:97
21:98	Figure 21.2: User case Epics
21:99	The creation of these work items is quite simple:
21:100
21:101	Inside each work item, we link the different types of work items, as you can see in Figure 21.3.
21:102	It is important to determine that the connections between work items are useful during software development. Hence, as a software architect, you must provide this knowledge to your team, and, more than that, you must incentivize them to make these connections:
21:103
21:104
21:105	Figure 21.3: Defining a Feature link to the Epic selected
21:106
21:107	As soon as you create a Feature work item, you will be able to connect it to several User Story work items that detail its specifications. The following screenshot shows the details:
21:108
21:109
21:110	Figure 21.4: Product Backlog work item
21:111
21:112	After that, Task and Test Case work items can be created for each User Story work item. The user interface provided by Azure DevOps is efficacious because it enables you to track the chain of functionalities and the relationships between them.
21:113
21:114
21:115	Figure 21.5: Board view
21:116
21:117	Considering we are using Scrum as the basis for the Agile process, as soon as you complete the input for the User Story and Task work items, you will be able to plan the project sprints together with your team. The plan view enables you to drag and drop User Story work items to each planned sprint/iteration:
21:118
21:119
21:120	Figure 21.6: Backlogs view
21:121
21:122	By clicking on a specific sprint on the right, you will see just the work items assigned to that sprint. Each sprint page is quite like the backlog page but contains more tabs, where you can define Sprint Period and Team Capacity, for instance.
21:123

21:24

21:25

Destination expert view:

21:26

The same view as the common user view

21:27

Answer questions asking for your destination expertise

21:28

Manage the points you scored by answering questions

21:29

Exchange points for tickets

21:30

21:31

21:32

Administrator view:

21:33

Manage packages

21:34

Manage common users

21:35

Manage destination experts

21:36

21:37

21:38

21:39

Besides the functionalities asked for on the platform, it is important to note that WWTravelClub intends to have more than 100 destination experts per package and will offer around 1,000 different packages all over the world.

21:40

It is important to know that, in general, customers do not bring the requirements ready for development. That is why the process of gathering requirements is so important, as described in Chapter 1, Understanding the Importance of Software Architecture. This process will transform the list presented above into user needs and system requirements. Let’s check how this will work in the next section.

21:41

User needs and system requirements

21:42

As presented in Chapter 1, Understanding the Importance of Software Architecture, to summarize the user needs, you may use the User Story pattern. We have used this approach here so that you can read the following user stories for WWTravelClub:

21:43

21:44

US_001: As a common user, I want to view promotional packages on the home page so that I can easily find my next vacation.

21:45

US_002: As a common user, I want to search for packages I cannot find on the home page so that I can explore other trip opportunities.

21:46

US_003: As a common user, I want to see the details of a package so that I can decide which package to buy.

21:47

US_004: As a common user, I want to register myself so that I can start buying the package.

21:48

US_005: As a registered user, I want to process the payment so that I can buy a package.

21:49

US_006: As a registered user, I want to buy a package with an expert recommendation included so that I can have an exclusive trip experience.

21:50

US_007: As a registered user, I want to ask for an expert so that I can find out the best things to do on my trip.

21:51

US_008: As a registered user, I want to comment on my experience so that I can give feedback on my trip.

21:52

US_009: As a registered user, I want to review an expert who has helped me so that I can share with others how fantastic they were.

21:53

US_010: As a registered user, I want to register as a destination expert view so that I can help people who travel to my city.

21:54

US_011: As an expert user, I want to answer questions about my city so that I can score points to be exchanged in the future.

21:55

US_012: As an expert user, I want to exchange points for tickets so that I can travel around the world more.

21:56

US_013: As an administrator user, I want to manage packages so that users can have fantastic opportunities to travel.

21:57

US_014: As an administrator user, I want to manage registered users so that WWTravelClub can guarantee good service quality.

21:58

US_015: As an administrator user, I want to manage expert users so that all the questions regarding our destinations are answered.

21:59

US_016: As an administrator user, I want to offer more than 1,000 packages around the world so that different countries can experience the WWTravelClub service.

21:60

US_017: As the CEO, I want to have more than 1,000 users simultaneously accessing the website so that the business can scale effectively.

21:61

US_018: As a user, I want to access WWTravelClub in my native language so that I can easily understand the package offered.

21:62

US_019: As a user, I want to access WWTravelClub in the Chrome, Firefox, and Edge web browsers so that I can use the web browser of my preference.

21:63

US_020: As a user, I want to know that my credit card information is stored securely, so I can buy packages safely.

21:64

US_021: As a user, I want to get a recommendation of a good place to visit according to other people from my city, so I can find out about new places that fit my style.

21:65

21:66

Notice that while writing the stories, information related to non-functional requirements such as security, environment, performance, and scalability can be included.

21:67

However, some system requirements may be omitted when you write user stories and need to be included in the software specification. These requirements can be related to legal aspects, hardware, and software prerequisites, or even points of attention for the correct system delivery. We discussed them in Chapter 2, Non-Functional Requirements. So non-functional requirements need to be mapped and listed, as well as the user stories. The WWTravelClub system requirements are presented in the following list. Note that requirements are written in the future tense because the system does not exist yet:

21:68

21:69

SR_001: The system shall use cloud computing components to deliver the scalability required.

21:70

SR_002: The system shall respect General Data Protection Regulation (GDPR) requirements.

21:71

SR_003: Any web page of this system shall respond within at least 2 seconds of 1,000 users accessing it concurrently.

21:72

21:73

The idea of having this list of user stories and system requirements is to help you understand how complex the development of a platform might be if you think about it from an architectural perspective.

21:74

Now that we have the list of user stories for the platform, it is time to start selecting the .NET project types that will be used at WWTravelClub. Let’s check them in the next topic.

21:75

Main types of .NET projects used at WWTravelClub

21:76

The development of this book’s use case will be based on various kinds of .NET Core Visual Studio projects. This section describes all of them. Let us select New project in the Visual Studio File menu.

21:77

For instance, you can filter .NET Core project types by typing them into the search engine as follows:

21:78

21:79

Figure 21.1: Searching types of .NET Core projects in Visual Studio

21:80

There, you will find common C# projects (console, a class library, Windows Forms, and WPF), and various types of test projects, each based on a different test framework: xUnit, NUnit, and MSTest. Choosing among the various testing frameworks is just a matter of preference since they all offer comparable features. Adding tests to each piece of software that composes a solution is a common practice and allows the software to be modified frequently without jeopardizing its reliability.

21:81

You may also want to define your class library projects under .NET Standard, which was discussed in Chapter 5, Implementing Code Reusability in C# 12. These class libraries are based on standards that make them compatible with several .NET versions. For instance, libraries based on 2.0 standards are compatible with all .NET Core versions greater than or equal to 2.0, with all .NET versions greater than 5, and with all .NET Framework versions greater than 4.6. This compatibility advantage comes at the price of having fewer available features.

21:82

Besides filtering project types to the cloud, we have several more project types. Some of them will enable us to define microservices. Microservice-based architectures allow an application to be split into several independent microservices. Several instances of the same microservice can be created and distributed across several machines to fine-tune the performance of each application part. If you want to learn about microservices, we have talked about them in the following chapters:

21:83

21:84

Chapter 11, Applying a Microservice Architecture to Your Enterprise Application

21:85

Chapter 14, Implementing Microservices with .NET

21:86

Chapter 20, Kubernetes

21:87

21:88

In Chapter 2, Non-Functional Requirements, we described an ASP.NET Core application project in the subsection Creating a scalable web app with .NET 8. There, we defined an ASP.NET Core application, but Visual Studio also contains project templates for projects based on RESTful APIs and the most important single-page application frameworks, such as Angular, React, Vue.js, and the Blazor framework based on WebAssembly, which was discussed in Chapter 19, Client Frameworks: Blazor. Some of them are available with the standard Visual Studio installation, while others require the installation of an SPA package, called ASP.NET and web development workload.

21:89

21:90

To finish, testing projects were discussed in detail in Chapter 9, Testing Your Enterprise Application. We suggest you, as a software architect, try all the templates available at Visual Studio by creating proofs of concept that may help you define the best project types for your solution.

21:91

21:92

Now that we have checked these different project types, let’s have a look at Azure DevOps and how it can be helpful in managing WWTravelClub is requirements.

21:93

Managing WWTravelClub’s requirements using Azure DevOps

21:94

As discussed in Chapter 3, Managing Requirements, an important step for a software development project is where and how the team will organize the user stories mapped from the user needs. There, as described in the Managing system requirements in Azure DevOps section, Azure DevOps enables you to document system requirements using work items, which are mainly tasks or actions that need to be completed to deliver a product or service.

21:95

It is also important to remember that the work items available depend on the work item process you select while creating the Azure DevOps project.

21:96

Considering the scenario described for WWTravelClub, we decided to use the Agile process and have defined three Epic work items as follows:

21:97

21:98

Figure 21.2: User case Epics

21:99

The creation of these work items is quite simple:

21:100

21:101

Inside each work item, we link the different types of work items, as you can see in Figure 21.3.

21:102

It is important to determine that the connections between work items are useful during software development. Hence, as a software architect, you must provide this knowledge to your team, and, more than that, you must incentivize them to make these connections:

21:103

21:104

21:105

Figure 21.3: Defining a Feature link to the Epic selected

21:106

21:107

As soon as you create a Feature work item, you will be able to connect it to several User Story work items that detail its specifications. The following screenshot shows the details:

21:108

21:109

21:110

Figure 21.4: Product Backlog work item

21:111

21:112

After that, Task and Test Case work items can be created for each User Story work item. The user interface provided by Azure DevOps is efficacious because it enables you to track the chain of functionalities and the relationships between them.

21:113

21:114

21:115

Figure 21.5: Board view

21:116

21:117

Considering we are using Scrum as the basis for the Agile process, as soon as you complete the input for the User Story and Task work items, you will be able to plan the project sprints together with your team. The plan view enables you to drag and drop User Story work items to each planned sprint/iteration:

21:118

21:119

21:120

Figure 21.6: Backlogs view

21:121

21:122

By clicking on a specific sprint on the right, you will see just the work items assigned to that sprint. Each sprint page is quite like the backlog page but contains more tabs, where you can define Sprint Period and Team Capacity, for instance.

21:123