Sof tware Development From A to Z A Deep Dive into all the Roles Involved in the Creation of Sof tware — Olga Filipova Rui Vilão Software Development From A to Z A Deep Dive into all the Roles Involved in the Creation of Software Olga Filipova Rui Vilão Software Development From A to Z Olga Filipova Rui Vilão Berlin, Germany Berlin, Germany ISBN-13 (pbk): 978-1-4842-3944-5 ISBN-13 (electronic): 978-1-4842-3945-2 https://doi.org/10.1007/978-1-4842-3945-2 Library of Congress Control Number: 2018960193 Copyright © 2018 by Olga Filipova and Rui Vilão This work is subject to copyright. All rights are reserved by the Publisher, whether the whole or part of the material is concerned, specifically the rights of translation, reprinting, reuse of illustrations, recitation, broadcasting, reproduction on microfilms or in any other physical way, and transmission or information storage and retrieval, electronic adaptation, computer software, or by similar or dissimilar methodology now known or hereafter developed. Trademarked names, logos, and images may appear in this book. Rather than use a trademark symbol with every occurrence of a trademarked name, logo, or image we use the names, logos, and images only in an editorial fashion and to the benefit of the trademark owner, with no intention of infringement of the trademark. The use in this publication of trade names, trademarks, service marks, and similar terms, even if they are not identified as such, is not to be taken as an expression of opinion as to whether or not they are subject to proprietary rights. While the advice and information in this book are believed to be true and accurate at the date of publication, neither the authors nor the editors nor the publisher can accept any legal responsibility for any errors or omissions that may be made. The publisher makes no warranty, express or implied, with respect to the material contained herein. Managing Director, Apress Media LLC: Welmoed Spahr Acquisitions Editor: Louise Corrigan Development Editor: James Markham Coordinating Editor: Nancy Chen Cover designed by eStudioCalamar Cover image designed by Freepik (www.freepik.com) Distributed to the book trade worldwide by Springer Science+Business Media New York, 233 Spring Street, 6th Floor, New York, NY 10013. Phone 1-800-SPRINGER, fax (201) 348-4505, e-mail orders-ny@springer- sbm.com, or visit www.springeronline.com. Apress Media, LLC is a California LLC and the sole member (owner) is Springer Science + Business Media Finance Inc (SSBM Finance Inc). SSBM Finance Inc is a Delaware corporation. For information on translations, please e-mail [email protected], or visit http://www.apress.com/ rights-permissions. Apress titles may be purchased in bulk for academic, corporate, or promotional use. eBook versions and licenses are also available for most titles. For more information, reference our Print and eBook Bulk Sales web page at http://www.apress.com/bulk-sales. Any source code or other supplementary material referenced by the author in this book is available to readers on GitHub via the book's product page, located at www.apress.com/9781484239445. For more detailed information, please visit http://www.apress.com/source-code. Printed on acid-free paper We dedicate this book to our soon-to-be-born son Alex Table of Contents About the Authors ����������������������������������������������������������������������������������������������������xi About the Technical Reviewer �������������������������������������������������������������������������������xiii Acknowledgments ���������������������������������������������������������������������������������������������������xv Chapter 1: I Have An Idea! ����������������������������������������������������������������������������������������1 Introduction �����������������������������������������������������������������������������������������������������������������������������������1 Software Products and Ideas Behind Them ����������������������������������������������������������������������������������4 Different Models����������������������������������������������������������������������������������������������������������������������������7 Research and Development ����������������������������������������������������������������������������������������������������������8 Knowledge Sharing Platform ������������������������������������������������������������������������������������������������������10 Minimum Viable Product �������������������������������������������������������������������������������������������������������������12 Summary�������������������������������������������������������������������������������������������������������������������������������������13 Chapter 2: Roles, Responsibilities, and Methodologies ������������������������������������������15 Roles and Responsibilities ����������������������������������������������������������������������������������������������������������16 Business Owner ���������������������������������������������������������������������������������������������������������������������17 Product Manager �������������������������������������������������������������������������������������������������������������������18 Designers ������������������������������������������������������������������������������������������������������������������������������19 Backend ���������������������������������������������������������������������������������������������������������������������������������20 Frontend ��������������������������������������������������������������������������������������������������������������������������������21 Quality Assurance (QA) ����������������������������������������������������������������������������������������������������������23 DevOps (development + operations) �������������������������������������������������������������������������������������24 It’s Normal to be Confused About Roles! �������������������������������������������������������������������������������24 v Table of ConTenTs Methodologies ����������������������������������������������������������������������������������������������������������������������������27 Scrum ������������������������������������������������������������������������������������������������������������������������������������29 Kanban ����������������������������������������������������������������������������������������������������������������������������������37 Ok, But What Should I Use? ���������������������������������������������������������������������������������������������������39 Our Team and Process ����������������������������������������������������������������������������������������������������������������42 Summary�������������������������������������������������������������������������������������������������������������������������������������44 Chapter 3: Requirements, Commitment, and Deadlines �����������������������������������������47 Product Manager ������������������������������������������������������������������������������������������������������������������������47 Interview With Product Manager �������������������������������������������������������������������������������������������������48 How People Become Product Managers and What They Deal With ���������������������������������������48 Differences Between Product Owner and Product Manager �������������������������������������������������49 Involvement on the Path From Idea to Product ���������������������������������������������������������������������50 Managing Products of Different Business Areas �������������������������������������������������������������������51 The Biggest Screw-Up �����������������������������������������������������������������������������������������������������������51 The Biggest Success �������������������������������������������������������������������������������������������������������������52 Preparation ���������������������������������������������������������������������������������������������������������������������������������52 Requirements and Roadmap �������������������������������������������������������������������������������������������������������52 Kick-Off ���������������������������������������������������������������������������������������������������������������������������������������55 Commitment and Deadline����������������������������������������������������������������������������������������������������������57 Requirements for Our MVP ����������������������������������������������������������������������������������������������������������59 Summary�������������������������������������������������������������������������������������������������������������������������������������63 Chapter 4: User-Centered Design ����������������������������������������������������������������������������67 Design Journey—Its Start and End ��������������������������������������������������������������������������������������������68 Personas and User Stories ����������������������������������������������������������������������������������������������������������71 Types of Design ���������������������������������������������������������������������������������������������������������������������������72 User Interface and User Experience ��������������������������������������������������������������������������������������������74 Design Process—How Designers Run It �������������������������������������������������������������������������������������82 Designing Our Online Education Platform �����������������������������������������������������������������������������������90 Initial Brainstorming��������������������������������������������������������������������������������������������������������������������90 Wireframes ����������������������������������������������������������������������������������������������������������������������������������92 vi Table of ConTenTs Usability Testing ��������������������������������������������������������������������������������������������������������������������������94 Visual Design ������������������������������������������������������������������������������������������������������������������������������97 Interview With a Product Designer ����������������������������������������������������������������������������������������������98 Summary�������������������������������������������������������������������������������������������������������������������������������������99 Chapter 5: Backend Development�������������������������������������������������������������������������101 About the Stack��� ����������������������������������������������������������������������������������������������������������������������102 Defining Backend Applications �������������������������������������������������������������������������������������������������102 Bootstrapping the Project ���������������������������������������������������������������������������������������������������������103 Build Automation Tool: Maven ���������������������������������������������������������������������������������������������������104 Database �����������������������������������������������������������������������������������������������������������������������������������108 Pros �������������������������������������������������������������������������������������������������������������������������������������109 Cons �������������������������������������������������������������������������������������������������������������������������������������109 Authentication ���������������������������������������������������������������������������������������������������������������������������115 Development �����������������������������������������������������������������������������������������������������������������������������118 Database �����������������������������������������������������������������������������������������������������������������������������120 Persistence Layer ����������������������������������������������������������������������������������������������������������������120 Service Layer �����������������������������������������������������������������������������������������������������������������������120 Service API ��������������������������������������������������������������������������������������������������������������������������120 REST API and Transformation Layer ������������������������������������������������������������������������������������121 Implementing the Registration ��������������������������������������������������������������������������������������������121 Testing���������������������������������������������������������������������������������������������������������������������������������������129 Summary�����������������������������������������������������������������������������������������������������������������������������������131 Chapter 6: Frontend Development ������������������������������������������������������������������������133 Let’s Code! ��������������������������������������������������������������������������������������������������������������������������������134 Where Does Frontend Start? �����������������������������������������������������������������������������������������������������136 Markup and DOM ����������������������������������������������������������������������������������������������������������������������138 Document Object Model ������������������������������������������������������������������������������������������������������139 Headings ������������������������������������������������������������������������������������������������������������������������������141 Hyperlinks ����������������������������������������������������������������������������������������������������������������������������141 Images ���������������������������������������������������������������������������������������������������������������������������������142 vii Table of ConTenTs Forms ����������������������������������������������������������������������������������������������������������������������������������144 Inline and Block Elements ���������������������������������������������������������������������������������������������������146 Style ������������������������������������������������������������������������������������������������������������������������������������������149 Layout ����������������������������������������������������������������������������������������������������������������������������������155 Design Systems �������������������������������������������������������������������������������������������������������������������158 Pre-Processors and Template Engines �������������������������������������������������������������������������������������158 Dynamic Content �����������������������������������������������������������������������������������������������������������������������161 Development Tools Console �������������������������������������������������������������������������������������������������162 Variables ������������������������������������������������������������������������������������������������������������������������������163 Including JavaScript ������������������������������������������������������������������������������������������������������������163 Functions �����������������������������������������������������������������������������������������������������������������������������166 Frameworks ������������������������������������������������������������������������������������������������������������������������������168 Contract Between Frontend and Backend ��������������������������������������������������������������������������������172 Creating the Frontend Application for Our Platform ������������������������������������������������������������������177 IDEs �������������������������������������������������������������������������������������������������������������������������������������������179 Summary�����������������������������������������������������������������������������������������������������������������������������������180 Chapter 7: Testing Our Product �����������������������������������������������������������������������������181 Different Types of Testing ����������������������������������������������������������������������������������������������������������181 Unit Testing ��������������������������������������������������������������������������������������������������������������������������181 Integration Testing ���������������������������������������������������������������������������������������������������������������183 System Testing ��������������������������������������������������������������������������������������������������������������������185 Acceptance Testing��������������������������������������������������������������������������������������������������������������186 Regression Testing ��������������������������������������������������������������������������������������������������������������187 Who Is Testing What? ����������������������������������������������������������������������������������������������������������������188 Manual QA Tester �����������������������������������������������������������������������������������������������������������������189 Automation QA Tester ����������������������������������������������������������������������������������������������������������190 From Manual to Automation Tester ��������������������������������������������������������������������������������������191 Tools, Platforms, and Frameworks ��������������������������������������������������������������������������������������������193 viii Table of ConTenTs Testing Our Product �������������������������������������������������������������������������������������������������������������������200 Manual Testing ��������������������������������������������������������������������������������������������������������������������200 Unit Tests for the Frontend ��������������������������������������������������������������������������������������������������203 Summary�����������������������������������������������������������������������������������������������������������������������������������206 Chapter 8: Let’s Go Live! ���������������������������������������������������������������������������������������209 How to Publish Your Software Project? �������������������������������������������������������������������������������������210 When Do We Start Thinking About Deployment?�����������������������������������������������������������������������213 Where Do I Put My Code? ����������������������������������������������������������������������������������������������������������214 Continuous Integration and Automated Tests����������������������������������������������������������������������������216 Continuous Delivery and Deployment ���������������������������������������������������������������������������������������218 Who Does What and How? ��������������������������������������������������������������������������������������������������������220 Interview With DevOps ��������������������������������������������������������������������������������������������������������������221 Monitoring and Alerting�������������������������������������������������������������������������������������������������������������227 Analytics �����������������������������������������������������������������������������������������������������������������������������������228 Hosting and Creating a CI/CD for Our Platform �������������������������������������������������������������������������229 Hosting ��������������������������������������������������������������������������������������������������������������������������������229 Continuous Integration and Deployment �����������������������������������������������������������������������������232 Summary�����������������������������������������������������������������������������������������������������������������������������������235 Chapter 9: Maintaining and Improving Your Software ����������������������������������������237 Maintaining �������������������������������������������������������������������������������������������������������������������������������238 Backups �������������������������������������������������������������������������������������������������������������������������������238 Replication ���������������������������������������������������������������������������������������������������������������������������239 Natural Disasters and Cosmic Rays �������������������������������������������������������������������������������������240 Improving ����������������������������������������������������������������������������������������������������������������������������������242 Scaling ���������������������������������������������������������������������������������������������������������������������������������243 Handling Feedback ��������������������������������������������������������������������������������������������������������������246 Bug Fixing ����������������������������������������������������������������������������������������������������������������������������247 Refactoring, Rewriting, and Technical Debt �������������������������������������������������������������������������252 Redesigning and Rebranding ����������������������������������������������������������������������������������������������255 Summary�����������������������������������������������������������������������������������������������������������������������������������257 ix Table of ConTenTs Chapter 10: Wrapping Up With Some Tips and Tricks ������������������������������������������259 Development Tips ����������������������������������������������������������������������������������������������������������������������259 Choosing Programming Languages or Frameworks �����������������������������������������������������������260 Code Style Guidelines ����������������������������������������������������������������������������������������������������������260 Code Reviews and Pair Programming ���������������������������������������������������������������������������������261 Quality Assurance Tips ��������������������������������������������������������������������������������������������������������������263 DevOps Tips ������������������������������������������������������������������������������������������������������������������������������264 What About My Idea? ����������������������������������������������������������������������������������������������������������������265 Project and Product Management Tips �������������������������������������������������������������������������������������269 Time Management Tips �������������������������������������������������������������������������������������������������������271 Team Management Tips ������������������������������������������������������������������������������������������������������������272 Trust �������������������������������������������������������������������������������������������������������������������������������������274 Appreciate ���������������������������������������������������������������������������������������������������������������������������277 Invest in Education ��������������������������������������������������������������������������������������������������������������278 Be the Best to Hire the Best ������������������������������������������������������������������������������������������������280 Reflect on Everything ����������������������������������������������������������������������������������������������������������281 Create YOUR Thing ���������������������������������������������������������������������������������������������������������������282 Summary�����������������������������������������������������������������������������������������������������������������������������������283 Index ���������������������������������������������������������������������������������������������������������������������285 x