{"id":3327,"date":"2021-01-04T01:36:40","date_gmt":"2021-01-04T01:36:40","guid":{"rendered":"https:\/\/wiki.thomasandsofia.com\/?p=3327"},"modified":"2021-01-04T01:36:40","modified_gmt":"2021-01-04T01:36:40","slug":"software-engineering-basics","status":"publish","type":"post","link":"https:\/\/wiki.thomasandsofia.com\/?p=3327","title":{"rendered":"Software Engineering Basics"},"content":{"rendered":"<p><a href=\"https:\/\/www.youtube.com\/watch?v=sB2iQSvrcG0\" target=\"_blank\" rel=\"noopener\">https:\/\/www.youtube.com\/watch?v=sB2iQSvrcG0<\/a><\/p>\n<h3><a href=\"https:\/\/wiki.thomasandsofia.com\/wp-content\/uploads\/2021\/01\/prototype1.jpeg\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-3328\" src=\"https:\/\/wiki.thomasandsofia.com\/wp-content\/uploads\/2021\/01\/prototype1.jpeg\" alt=\"\" width=\"553\" height=\"321\" srcset=\"https:\/\/wiki.thomasandsofia.com\/wp-content\/uploads\/2021\/01\/prototype1.jpeg 553w, https:\/\/wiki.thomasandsofia.com\/wp-content\/uploads\/2021\/01\/prototype1-300x174.jpeg 300w, https:\/\/wiki.thomasandsofia.com\/wp-content\/uploads\/2021\/01\/prototype1-150x87.jpeg 150w\" sizes=\"auto, (max-width: 553px) 100vw, 553px\" \/><\/a><\/h3>\n<h3>What is software engineering?<\/h3>\n<ul>\n<li>A standardized, structured and thorough approach to writing code.<\/li>\n<li>Treating the whole development process in a standardized manner.<\/li>\n<\/ul>\n<h3>Why bother?<\/h3>\n<ul>\n<li>Ensure you are building the right product.<\/li>\n<li>Design code to a certain standard.\n<ul>\n<li>Conventions and coding styles become important when working in a team.<\/li>\n<\/ul>\n<\/li>\n<li>Ensure the code meets a level of rigor.\n<ul>\n<li>Must be correct<\/li>\n<li>Efficient<\/li>\n<li>Secure<\/li>\n<\/ul>\n<\/li>\n<\/ul>\n<h1>Stage 1: Requirements Gathering and Analysis<\/h1>\n<p>Understanding what the customer wants<\/p>\n<h2>Gathering<\/h2>\n<h3>Customer provided list<\/h3>\n<ul>\n<li>Have customer provide a list of requirements<\/li>\n<li>List could be long, but not useful for development<\/li>\n<\/ul>\n<h3>Conversational<\/h3>\n<p>You take the notes and results will be more productive.<\/p>\n<ul>\n<li>Surveys<\/li>\n<li>Interviews<\/li>\n<li>Focus Groups<\/li>\n<li>Observations\n<ul>\n<li>If an existing package exists, watch how your client uses it.<\/li>\n<li>Watch for pain points<\/li>\n<\/ul>\n<\/li>\n<\/ul>\n<h3>Use Case Analysis<\/h3>\n<ul>\n<li>Have client describe a real usage scenario\n<ul>\n<li>Point of view of the user, no jargon or technical info.<\/li>\n<li>Written as a list, emphasizing End Results and Steps taken.<\/li>\n<\/ul>\n<\/li>\n<li>Extensions: &#8220;What if&#8221; error detection and how to handle<\/li>\n<li>Preconditions: Requirements to run the software<\/li>\n<li>Postconditions: What measures success?<\/li>\n<\/ul>\n<h4>Use Case Analysis Example:<\/h4>\n<ul>\n<li>Use Case: Record a sale onto the system<\/li>\n<li>Role: Sales Staff<\/li>\n<li>Main Success Scenario:\n<ol>\n<li>User initiates an &#8220;Add Sale&#8221; operation<\/li>\n<li>Software request the name and quantity of the item sold.<\/li>\n<li>User inputs name and qty and confirms the action<\/li>\n<li>Software stores the new entry into the system<\/li>\n<\/ol>\n<\/li>\n<li>Extensions:\n<ul>\n<li>User inputs qty less than 1<\/li>\n<li>Software indicates the qty is invalid<\/li>\n<li>Use case returns to step 2<\/li>\n<\/ul>\n<\/li>\n<li>Preconditions\n<ul>\n<li>User is logged in as Sales staff<\/li>\n<\/ul>\n<\/li>\n<li>Postconditions\n<ul>\n<li>Entry is stored in the system.<\/li>\n<\/ul>\n<\/li>\n<\/ul>\n<h3>User Stories<\/h3>\n<p>A simpler, though less detailed, formulation of the requirements.<\/p>\n<p>User stories should contain the 3 pieces of information<\/p>\n<ul>\n<li>Who they are<\/li>\n<li>What they want to do<\/li>\n<li>Why they want to do it<\/li>\n<\/ul>\n<h4>User Story Example<\/h4>\n<ul>\n<li>As a <strong>Sales Staff<\/strong>, I want to be able to <strong>add new sales to the system<\/strong>, such to <strong>have a record<\/strong> of all transactions.<\/li>\n<\/ul>\n<p>&nbsp;<\/p>\n<h2>Analysis<\/h2>\n<h3>Functional requirements<\/h3>\n<p>What we need the system to do<\/p>\n<ul>\n<li>Ex: Strore and retrieve information about sales<\/li>\n<\/ul>\n<h3>Non-Functional requirements<\/h3>\n<p>A characteristic or property of the system.\u00a0 Describes something about the process.<\/p>\n<ul>\n<li>Performance\n<ul>\n<li>Ex: Records must be retrieved within 3 seconds<\/li>\n<\/ul>\n<\/li>\n<\/ul>\n<h2>Prototyping<\/h2>\n<ul>\n<li>Build a (usually non-functional) system that represents the visual layout and linkage of features.\n<ul>\n<li>Might be some type of code<\/li>\n<li>Power Point slides<\/li>\n<\/ul>\n<\/li>\n<li>Give the client a good idea of how the software will look, feel and perform prior to design<\/li>\n<li>There may be a lot of back and forth in this stage.\n<ul>\n<li>Only once this has been completed can you move forward into serious development.<\/li>\n<\/ul>\n<\/li>\n<\/ul>\n<p><a href=\"https:\/\/wiki.thomasandsofia.com\/wp-content\/uploads\/2021\/01\/prototype-example.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-3329\" src=\"https:\/\/wiki.thomasandsofia.com\/wp-content\/uploads\/2021\/01\/prototype-example.png\" alt=\"\" width=\"1077\" height=\"381\" srcset=\"https:\/\/wiki.thomasandsofia.com\/wp-content\/uploads\/2021\/01\/prototype-example.png 1077w, https:\/\/wiki.thomasandsofia.com\/wp-content\/uploads\/2021\/01\/prototype-example-300x106.png 300w, https:\/\/wiki.thomasandsofia.com\/wp-content\/uploads\/2021\/01\/prototype-example-768x272.png 768w, https:\/\/wiki.thomasandsofia.com\/wp-content\/uploads\/2021\/01\/prototype-example-1024x362.png 1024w, https:\/\/wiki.thomasandsofia.com\/wp-content\/uploads\/2021\/01\/prototype-example-150x53.png 150w\" sizes=\"auto, (max-width: 1077px) 100vw, 1077px\" \/><\/a><\/p>\n<p>&nbsp;<\/p>\n<h1>Stage 2: Planning<\/h1>\n<ul>\n<li>Decide how you want to do things over the coming weeks and months.<\/li>\n<li>This provides a road map that defines how the different parts are going to interact with each other<\/li>\n<li>How to approach developing them<\/li>\n<\/ul>\n<h2>Modularization<\/h2>\n<ul>\n<li>Breaking large programs\/projects into smaller parts<\/li>\n<\/ul>\n<h1><span style=\"color: #ff0000;\">10:40 &#8211; Stopping note taking here<\/span><\/h1>\n","protected":false},"excerpt":{"rendered":"<p>https:\/\/www.youtube.com\/watch?v=sB2iQSvrcG0 What is software engineering? A standardized, structured and thorough approach to writing code. Treating the whole development process in a standardized manner. Why bother? Ensure you are building the right product. Design code to a certain standard. Conventions and coding styles become important when working in a team. Ensure the code meets a level ..<\/p>\n<div class=\"clear-fix\"><\/div>\n<p><a href=\"https:\/\/wiki.thomasandsofia.com\/?p=3327\" title=\"read more...\">Read more<\/a><\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[63],"tags":[],"class_list":["post-3327","post","type-post","status-publish","format-standard","hentry","category-software-engineering"],"_links":{"self":[{"href":"https:\/\/wiki.thomasandsofia.com\/index.php?rest_route=\/wp\/v2\/posts\/3327","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/wiki.thomasandsofia.com\/index.php?rest_route=\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/wiki.thomasandsofia.com\/index.php?rest_route=\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/wiki.thomasandsofia.com\/index.php?rest_route=\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/wiki.thomasandsofia.com\/index.php?rest_route=%2Fwp%2Fv2%2Fcomments&post=3327"}],"version-history":[{"count":1,"href":"https:\/\/wiki.thomasandsofia.com\/index.php?rest_route=\/wp\/v2\/posts\/3327\/revisions"}],"predecessor-version":[{"id":3330,"href":"https:\/\/wiki.thomasandsofia.com\/index.php?rest_route=\/wp\/v2\/posts\/3327\/revisions\/3330"}],"wp:attachment":[{"href":"https:\/\/wiki.thomasandsofia.com\/index.php?rest_route=%2Fwp%2Fv2%2Fmedia&parent=3327"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/wiki.thomasandsofia.com\/index.php?rest_route=%2Fwp%2Fv2%2Fcategories&post=3327"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/wiki.thomasandsofia.com\/index.php?rest_route=%2Fwp%2Fv2%2Ftags&post=3327"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}