Developer's Guidelines For

Enhancing Software Quality

By: Samar Gamal Zanaty

Supervised By:
Professor Dr. Sayed Abdel Gaber
 Agenda
 Developer's guidelines for enhancing software quality
 References
 1. Clever optimization with code readability

 Developers spend most of their time reading the code not writing it. Most of
the time they need to debug the application, check the commits done by other
developers, or reading about building a new feature they need to add to their
software. 

 They take care of the code readability and pay attention to writing the code
which is easy to understand and easy to modify even if they need to write
longer variable and function names. Writing more lines of code is completely
acceptable if it’s easy to understand and modify.
 2. Code Revision
 Ask a developer, and they will let you know that how revision control has saved them multiple
times when something went wrong in their codebase. No matter, whether you’re a sole
contributor to your small project or working with multiple developers on a big project,
revision control has become an essential tool to use in enterprises.
 Before working on any new feature or adding some code in the codebase make sure that you
take the code revision first. Who did what, what commits have been done, what has been
deleted, what has been added, what has been updated, etc.
 You need to do major changes to your application because it doesn’t meet customer’s
expectations. This issue is common in software development. Doing major changes in the
application is also a frustrating thing for developers.
 To avoid this issue, verify and validate your application throughout the various stages of
development and iterations. Ship your product in small releases instead of one bigger release.
Do not ship the product in the end when everything is done. 
 3. Verify and Validate the Application

 Verification: Make a good practice to evaluate and verify your product at different stages
of development. Check if the application meets the specified requirement or not. Check if it is
aligned to the design specifications or not.

 Validation: Sometimes developers misunderstand the product specification and requirement.

They focus on building the product and later when the product gets shipped, they hear the
issues from the users that the software doesn’t meet the requirements and it’s not built as
expected. 
 V model is developed by experts that shows how verification and validation happen at
different stages of software development. 
 4. Code Refactoring and TDD

 Bug…the most important part of every developer’s life. 

 How do you fix the bug in your code (we know you hate it when testers find a lot of bugs in
your code)?
 You might have been using different techniques, tools, and approaches to fix the bug in your
code. 
 One of the best ways to fix the bug in your code is TDD which as introduced by Kent Beck
 (American Software Engineer).
TDD
 5. Comments and Project Documentation
 Your code should be self-explanatory with fewer comments. Add comments wherever it’s
important but do not add unnecessary comments. Also, make sure that you update the
comments whenever you make changes in the code (a lot of programmers neglect this thing). 

 Documentations are very helpful for the users and for the developers who want to contribute
to your code. README file is one of the best ways to document your project. When a user
interacts with your project first time, this file helps them in understanding everything about
your project. 

 Explain what your project does, list all the dependencies, and provide detailed instruction on
how to work on the project. 
 References
 1. Graham, Dorothy, Rex Black, and Erik Van Veenendaal. Foundations of software testing
ISTQB Certification. Cengage Learning, 2021.

 2. Haq, Saif Ul, et al. "Project governance mechanisms and the performance of software
development projects: Moderating role of requirements risk." International Journal of Project
Management 37.4 (2019): 533-548.