SDLC Implementation Phase: Coding & Documentation

• Chapter 6 is about the Implementation Phase in System Analysis and Design Fundamentals (CSC 1403).
• After completing this chapter students should be able to explain deliverables of the implementation phase, list the types of system testing, and list the types of system installation

Implementation Phase Overview

• The implementation phase is the stage where the developed system is deployed within the organization.
• Activities involved include coding, software testing, system installation, documentation, user training, and post-implementation support.
• The main goal of implementation is ensuring the system functions smoothly and meets user requirements.

Step In Implementation Phase

• The steps include:
  • Coding/Code
  • Program Documentation

Coding/Code

• Coding is the process of writing instructions in a programming language to create software or applications.
• The purpose of coding is to transform the system design into a functional system by creating code to execute the planned tasks.
• Key activities include: writing code based on the system design documents, debugging and testing the code to ensure it works as expected, using best practices like code commenting, modularization, and error handling for maintainable and efficient code
• Tips:
  • Always follow coding standards to make your code readable and reusable
  • Use version control systems (e.g., Git) to track changes and collaborate.
  • Regularly test your code to identify and fix bugs early.

Program Documentation

• Program documentation involves creating detailed information about the program's design, code, and usage.
• The purpose of program documentation is to:
  • Help future developers, users, and maintainers understand and work with the software.
  • Serve as a reference for debugging, updating, or enhancing the program.
• Key activities:
  • Writing user manuals to guide end-users on how to operate the program.
  • Creating technical documentation such as flowcharts, algorithms, and database schemas.
  • Including in-code comments to explain the functionality of specific sections of the code.
• Tips include:
  • Keeping the documentation simple and clear for the intended audience (users or developers).
  • Updating the documentation whenever changes are made to the program.
  • Using tools, like Javadoc, Sphinx, or Markdown for creating professional documentation.

Software Testing

• Topics covered:
  • Software Application Testing
  • Master Test Plan
  • Types of Testing
  • Testing Process
  • Acceptance Testing

Software Application Testing

• Software testing is the process of evaluating a software application, to ensure that it meets the specified requirements, and is free of defects.
• The purpose of software testing is to verify the functionality, performance, and reliability of the software before deployment.
• Key points:
  • Identifies bugs or errors that need fixing
  • Ensures the software works as expected under different conditions.
• Tips:
  • Test frequently during development to catch issues early.
  • Use both manual and automated testing methods for thorough evaluation

Master Test Plan

• It is a detailed document outlining strategy, objectives, schedule, resources, and scope of testing activities.
• Purpose:
  • To provide a clear roadmap for the testing process
  • To ensure all aspects of the application are tested systematically
• Elements include:
  • Objectives and the scope of testing
  • Roles and responsibilities of the testing team.
  • Tools and techniques to be used
  • Risk analysis and mitigation plans
• Tips:
  • Keep the test plan aligned with the project goals
  • Regularly update the plan based on testing progress

Types of Testing

• Unit testing
  • Focuses on individual components, or functions, to ensure they work as intended
• Integration testing
  • Ensures that different modules, or components, interact correctly.
• System testing
  • Verifies that the entire system meets the specified requirements
• Performance testing
  • Evaluates the application's speed, scalability, and stability under various conditions.
• User acceptance testing (UAT)
  • Conducted with end-users to verify that the software meets their needs

Testing Process

• It involves:
  • Planning for the scope, objectives, and resources for testing
  • Designing test cases that cover all possible scenarios, including edge cases
  • Executing tests, running the test cases on the application
  • Recording results from each test case
  • Reporting bugs, identifying, and reporting defects found during testing.
  • Retesting to verify that the fixed issues are resolved and no new bugs have been introduced.

Acceptance Testing

• Acceptance testing ensures the software meets end-user or client requirements and is ready for deployment.
• Types:
  • Alpha testing: Conducted internally by the development team
  • Beta testing: Performed by a small group of actual users in a real-world environment
• Key points:
  • Focuses on usability, functionality, and performance
  • Helps to gain user confidence in the software.
• Tips:
  • Engage end-users early in the testing process
  • Document feedback to implement necessary changes.

Installation

• Installation sets up software on the user's system so it can function correctly.
• Installation involves copying files, configuring settings, and preparing the system for use.
• Key activities include:
  • Preparing the installation environment
  • Running the installation process to ensure software setup is correct
  • Configuring settings for optimal performance and usability

Types of Installation

• There are several installation methods used depending on project requirements and environment.
• Direct installation: new software is installed directly over the old version or onto a fresh system
  • Use:
    • When the system doesn't need to support the old version anymore
    • When users don't need to continue using the previous version.
  • Advantages: simple and quick installation, no need to maintain multiple versions
  • Disadvantages: risk of losing data or settings from the previous version if not handled correctly, can cause downtime if issues arise
• Parallel installation: new software is installed alongside the existing version, allowing both versions to run simultaneously
  • Use:
    • When the system must continue running the old version while testing or transitioning to the new one
    • When users need time to adapt to the new version without disrupting ongoing work
    • When there is no risk of data loss from the old version
  • Advantages: no risk of data loss, allows users to test the new version while still accessing the old version
  • Disadvantages: requires more system resources as both versions run at the same time, users may face confusion with two versions available
• Phased installation: new software is installed in stages, starting with a small group of users or systems before being rolled out to the entire organization or user base
  • Use:
    • When it’s is important to minimize risks by testing the new version in a limited environment before full deployment.
    • When there are a lot of users, and it's not feasible to install the software on all systems at once.
  • Advantages: allows for troubleshooting and adjustments before full rollout; reduces the risk of widespread issues
  • Disadvantages: can slow down the implementation process, because it takes place it in stages; may create inconsistencies

System Documentations

• System documentation refers to the written materials that describe the design, development, and operation of a software system.
• It serves as a reference for developers, maintainers, and users, ensuring the system functions properly and can be updated or modified when needed.
• The purposes of system documentation are:
  • To provide a detailed record of the software's structure, behavior, and usage
  • To ensure that other developers or maintainers can understand, manage, and enhance the system in the future

Types of Documentation

• System documentation can be categorized into different types based on target audience and purpose.
• Internal Documentation: intended for developers, system administrators, or other technical teams involved in the development, maintenance, or debugging of the system.
  • Purpose: To provide detailed info about the code, logic, architecture, and design of the system
  • Elements: code comments, design and database diagrams -Tips: Use clear naming conventions and effective commenting
• External Documentation: created for users, stakeholders, or other non-technical audiences to understand how to interact with the system.
  • To guide users in installing, configuring, and using the software.
  • Elements: user manuals, install guides, troubleshooting etc
  • Tips: Keep the language simple

System Documentation

• Focuses on the internal working of software
• Meant for developers, testers, and administrators, to understand and maintain the system.
• Purpose: Is to ensure the system can be easily modified, maintained, and extended.
  • Elements: System/architecture design, class and function descriptions, database design, schemas
  • Tips: Ensure documentation reflects the system design & is up to date

User Documentation

• Created for end-users who will interact with the system
• Focuses on guiding users when using the system effectively.
• Purpose: To help users understand and take advantage of the system's feature

System and User Documentation

• System and user documentation serve different, but necessary, purposes for overall software success
• Both internal and external documentation are critical for documentation and use of software.

User Training and Support

• User training and support refer to the activities and resources provided to help end-users to understand, and troubleshoot the software effectively.
• This ensures that users can take full advantage of the software's capabilities and resolve any issues.
• The purpose of user training is to provide users with the knowledge and skills they need to effectively use the system, and receive the necessary assistance when facing challenges or issues.

Types Of Training Methods

• Instructor-Led Training (ILT)
  • Definition: An instructor teaches users in a structure and classroom-like setting
  • When to use:
    • Need for direct interaction and real time feedback
    • Large groups and specific teams
  • Advantages: personalized instruction and clarification, and adaptability
  • Disadvantages: required scheduling and can be costly
• Self-Paced Training
  • Users complete training modules on their own time
  • When to use:
    • User needs the flexibility to learn at their own pace
    • Large members make it hard to conduct personal training
  • Advantages: flexible and easy to customize, cost effective with no instruction required
  • Disadvantages: User may feel isolated or need more support, with less interaction and feedback from instructors
• On-the-Job Training (OJT)
  • Definition: Takes place in the users working environment under the supervision of a mentor
  • When to use: to improve practical understanding of the software and integrate training into workflow.
  • Advantages: Allows for hands one experience and immediate skill application.
  • Disadvantages: disrupts work processes and needs qualified mentors
• Workshops and Seminars
  • Group training sessions that focus on aspects of sotware
  • When to Use: Learn about/discover a new feature/aspect of the software
  • Advantages: interactive and covers many topics, encourages collaboration
  • Disadvantages: fast paced and may not address individuals needs
• Online Help and Tutorials
  • Definiton: Web-based resources that provide users with on-demand information.
  • When to use: Guides help when the user wants quick self guided support
  • Advantages: Helps resolve problems at any time -Disadvantages: Can be confusing and may not resolve the direct issue

Support issues

• Support issues are challenges or problems users encounter when using the system that should be addressed quickly and efficiently.
• Technical issues: Problems related to the system's performance, compatibility, or functionality.
  • Examples: Software crashes, errors, or bugs; or system configuration problems
  • Support actions: Provide solutions, updates, or bug fixes
• User Errors: Mistakes or misunderstandings caused by not understanding the software.
  • Examples: Incorrect data entry or misuse of features
  • Support Actions: User training or clarification on the processes
• Access and Permission Issues
  • Problems relate to user rights/access
  • Support: Verify credentials and user rights or resolve issues with user permissions
• System Updates and Maintenance
  • Definition: Issues that keep the software up to date
  • Examples: Arising problems when installing/updating
• Customization and Configuration Support
  • Definition: Problems related to users settings to needs that the system has a customisation for
  • Example: Difficult adjusting settings
  • Actions: Tutorials or configuration guides

Documentation of the Implementation Phase

• Documentation during the implementation phase involves recording all activities, process, those related to the software, for future deployment.
• Ensures that the development can be well documented for improvements
• Allows the information about the user, developer, and operation of the software

System Design Documentation

• Details on the system framework, architecture components and design of the development.
• The goal is to guide administrators when understanding or designing the structure to resolve any troubleshooting.
• It contains system architecture, Entity, or relationship diagram and servers/databases.

Installation Documentation

• Instructions on how to install the software, including any prerequisites, configuration steps, and setup procedures.
• This is to ensure that it can be properly created in any type of environment.
• They are step by step guides, and dependencies that can resolve trouble shooting issues.

User Documentation

• Information on how to use specific steps for users, like manuals, helpful tips and FAQs
  • It ensures external support to understand how things work and can solve common/minor issues.
  • Troubleshooting tips, with steps and interface descriptions

Test Documentation

• Include testing processes, and issues identified during testing. -Quality assurance, with test cases; ensuring software runs smoothly with no bugs

Configuration and Customization Documentation

• Information on changes made to the system during installation with custom requirements based on the environment.
  • With customized settings and new features

Maintenance and Support Documentation

• Procedures and guidelines that ensure the system can be maintained when deployed and when to resolve system failures.
  • Includes, scheduled updates, maintenance and contact info.

Backup and Recovery Documentation

• Backing up procedures to ensure data integrity/availability in case unexpecting issues should arise with the system
  • Including backUp schedules and methods and where the data can be stored.

Conclusion:

• Effective documentation ensures that the system can be deployed correctly & efficiently.
• With easy organization and detailed documentation; can lead to a higher success rate and prevent many common issues.

Explore key aspects of the system development lifecycle's implementation phase, covering coding practices, version control, and the importance of comprehensive program documentation for maintainability and collaboration.