Software Engineering Detailed Documentation Outline
Methodology of the Study (Software Engineering Paradigm) In this section, the developers will present the software engineering paradigm that they had chosen in developing the system. Sample paradigms include that of SDLC, Waterfall Process, and Prototyping among others. This chapter will include a brief description of the paradigm that the developers had selected and its significance to the system that they are creating or developing.
Since it is imperative that each paradigm has its own predefined phases in the development for any system, the developers should also present all the activities they had undertaken in each phase of their chosen paradigm. Do note, however, that the activities presented in this section should start from the moment that the target system was identified until the maintenance of the completed system. 3. 0 Data Gathering Procedures and Outputs (define requirements of software) These chapter details the information gathering techniques used by the developers in order to complete the presented system.
More Essay Examples on Software Rubric
As information is necessary for the design and completion of any system, a development team should be able to gather these in the most methodical yet appropriate way. Based on the theoretical concepts in computing sciences, there are a lot of means in gathering data and information like interviews, use of questionnaires, etc. though each means may not be appropriate for all systems development processes. In this section, the developers will present their data gathering processes and a summary of the gathered information.
Included in this chapter would be the presentation and definition of their chosen data gathering techniques and a summary of the gathered information based on the said techniques. Please note that only a summary of the information gathered is presented in this section as the complete excerpts of the data gathering processes and outputs will be presented as an appendix. 4. 0 Documentation of the Current System As any system is based on existing manual processes, this section is used to present the actual processes employed by the target company of the systems development project.
It is noted however, that only the manual processes and other significant activities that are covered by the systems development project are to be presented in detail in this chapter. If the project is a prototype or a generic system, review of related companies and their processes significant to the project development are instead presented in this chapter. 5. 0 Software/Project Estimation 5. 1 Schedule of Activities The schedule of activities is a time-line based listing of activities that are to be implemented in the systems development process. . 2 Cost Estimation As the process of systems development involves a lot of factors, cost estimation presents the approximated financial value of the final product. As there are several factors (like the human, technical, environmental and political factors) affecting software cost, setting up the financial value of a project may be difficult. Though it may be that hard to determine the actual cost of the system, there are a few things that to be taken in consideration in this section: a.
Research on similar software and create a comparison between them. b. Estimate the size and depth of the software development project either by problem-based estimation techniques (objectives of the system) or process-based techniques (scope of the system). c. Technical aspects (Complexity of the system, programming, etc. ); Human involvement (number of developers involved, cost per programmer); Calendar days involved (time of development); Financial Environment (software costs in the market today). d.
Hardware and Software Considerations. This chapter is presented in two parts: Software Costs Estimation and Hardware Costs Estimation with justification on the presented estimation. As a bottom-line for this chapter, what is actually presented in this section is the actual cost of the software in Philippine Peso. 6. 0 Requirements Analysis Specification (model system requirements) This chapter is about the analysis of the data gathered for the manual process from which the system development was based from.
Since the manual processes were presented in Chapter 4, this chapter deals with the analysis of the data that was gathered. 6. 1 Process Specification/Modelling The analysis of the data gathered is presented through the use of the Data Flow Diagram modelling tool. Information analyzed in this section includes manual activities employed by the target company as well as the different entities involved in the manual processes. 6. 2 Data Specification/Modelling In this subsection, the analysis of the data gathered is presented through the use of the Entity Relationship Diagram modelling tool.
In here, all manual documents are presented along with the relationship of each document. 7. 0 Software Design Specification Just like in the previous chapter, the analysis of data gathered is presented through the use of the different modelling tools available for the software engineer. In this section, the focus is however, placed on the target system. 7. 1 Process Specification In this subsection, the target system is presented through the use of the Data Flow Diagram.
Do note that in this section, the data flow diagram shows how the system handles input information from the user, processes that information and how it is reported back to the user through outputs, reports, forms and other documents generated by the system. 7. 2 Data Specification This subsection deals with the presentation of the system database in its raw format and how these tables are related to each other. The use of the Entity Relationship Diagram modelling tool is used in this subsection. 7. 3 Screen/Interface Specification This section is used for the presentation of the system’s screenshots.
It is to be noted that only the major modules are presented in here as screenshots. System modules which have similar functionalities with other system features such as the maintenance features of the system are presented only as a single entity. 7. 4 Program/Module Specification As was mentioned in the previous subject, only the major modules are presented as well in this section. In this section, the actual code may be presented only as an example but the main idea of this subsection is the presentation of the concept behind the module being presented.
Concepts would include module design and functionality. 8. 0 Software Implementation This section deals with the detailed specification on how the system will be implemented and used. 8. 1 Programming Considerations, Issues, and Tools 8. 2 System Requirements Specification The system requirements specification is a detailed listing on what are the things required to have the system up and running effectively and efficiently. In this section, it is important to note that all requirements specified in this section should readily be available in the market.
Each subsection is divided into two parts: minimum requirements and recommended requirements. The Minimum Requirements specification lists down the basic system specifications that the target system could functionally operate while the Recommended Specifications lists down the best system specification for the system. 8. 2. 1 Hardware Requirements This subsection deals with the hardware needs of the system. This may include the detailed specification of the PC needed for the system, networking requirements and other hardware peripherals need 8. 2. 2 Software Requirements
While the previous section deals with the hardware requirements, this section deals with the software requirements of the system. It is to be noted that only the software deemed as necessary for the complete functionality of system are to be listed in this section. 8. 2. 3 Human Resource Requirements This section is a listing of the human resources needed for the effective use of the system as well as the detailed work and job specification of the each human resource. Sample resource would include that of the encoders, transaction users, administrative users, etc. 8. 3 Software Testing
This section deals with the test case scenarios applied to the system in order to check its functionality as well as confirmation to the user requirements and system objectives. 8. 3. 1 Testing Activities This subsection deals with the detailed enumeration and explanation of test cases applied to the system. This subsection should be able to answer the following questions: What – are the test cases that are applied to the system modules; when – were these scenarios applied into the system; why – were these cases selected as test activities for the system and how – are these test activities applied to the target system modules? . 3. 2 Test Cases This section lists down all the test cases used within the testing activities implemented by the developers. This section also includes all notes about the expected behaviour and outcome of the test activities when these test cases are used for each target module. 8. 4 Installation Process Subsection 8. 4 provides a detailed instructional set on how the system installation is to be done. This would include notes on the needed software installers and peripherals. 9. 0 Software Maintenance Plan
As presented in any systems paradigm, after the system had been installed and deemed as functional within the target company, maintenance is the last phase in keeping the system working effectively as possible. This section deals with the developers course of action after the system had been deployed. This section offers plans and options for any possible system updates as requested by the users or the Target Company, bugs and errors that were not uncovered during the installation process as well as functionalities that were not covered by the actual system. Appendices
This section contains all the transcripts, diagrams, tables and other illustrations that were mentioned in the previous chapters but was indicated to be presented in detail in this section. Bibliography Since all written documentations are created from the data gathered from the target client as well as information coming from various sources, due credit is to be given out to the original sources of the documentation. The Bibliography sections lists down all the sources of information, quotations, phrases used by the developers in the documentation process. Resource Persons