table of Contents
-
range
-
total requirements
2.1 General functional requirements
2.2 Software Development Platform Requirements
Development and implementation of process management software project requires 2.3
2.3.1 software implementation of the project general requirements
2.3.2 software project requirements change
2.3.3 software project implementation milestones control
- Software Development
3.1 Software requirements analysis
3.1.1 Requirements Analysis
Preparers needs analysis report 3.1.2
3.1.3 needs assessment report
3.1.4 demand report format
3.2 Summary of design software
3.2.1 Summary of design
Written summary of the design requirements of 3.2.2
3.2.3 writers outline design report
3.2.4 Summary of design and requirements analysis, the relationship and differences between the detailed design
3.2.5 Summary of design review
3.2.6 Summary of design format
Detailed Design 3.3 software
3.3.1 Detailed Design
3.3.2 Special
3.3.3 detailed design requirements
3.3.4 Database Design
3.3.5 detailed design review
3.3.6 detailed design format
3.4 encoding software
3.4.1 software coding
3.4.2 software coding requirements
3.4.3 encoded review
3.4.4 programming specifications and requirements
3.5 Software Testing
3.5.1 Software Testing
3.5.2 Test Plan
3.6 software is ready to deliver
3.6.1 Delivery list
Identification and acceptance 3.7 software
Identification and acceptance 3.7.1 software
3.7.2 inspection personnel
3.7.3 Acceptance details
3.7.4 software acceptance testing Outline
3.8 Training
3.8.1 System Application Training
Training Management System 3.8.2 (optional)
Appendix A needs analysis document template software
Appendix B Software design report summary document template
Appendix C report detailed design document template software
Appendix D document template software database design report
Appendix E Software Testing (acceptance) Outline 5
- range
Use this guide to software developers to develop software for the process of Nanjing Department of Transportation projects, undertaken by the unit's specification process of software development to improve software quality, the purpose of reducing maintenance costs. Developers should be prepared for software development and software development documentation in accordance with these guidelines. This guide is to assume the basic requirements for units of software projects. This guide is provided in Appendix A to E in the preparation of the document template for developers to reference, during the development, the developer recoverable prepared in accordance with the actual situation of specific software, but must provide a document agreed by the parties, the document content must be agreed describe clearly.
2. General requirements
2.1 General functional requirements
Network application environment for Internet / Intranet technology as the core.
Developers should be based on a full analysis of the needs, opt of B / S or C / S structure.
Database software system shall be designed and constructed in accordance with the "Nanjing Department of Transportation information database construction norms."
This guide is not what specific engineering software development using the method specified developer, the developer according to the specific characteristics of the project, to choose their own good at using the method of process-oriented, object-oriented methods or data-oriented approach, it is recommended that developers use Object-oriented software engineering, such as: the use of currently widely used RUP (Rational Unified Process) methods for analysis, design and development.
2.2 Software Development Platform Requirements
Developers to develop software must be able to run properly on regulations in Nanjing Department of Transportation software platform. Currently software platform:
Database management systems:
Oracle 9i or later
Middleware (application server) system:
IBM WebSphere
OA system:
Lotus Domino/Notes
Network Architecture:
Fully supports the TCP / IP protocol
Development tool or technology system:
To ensure the development of the upper and lower software compatibility, developers should choose a newer version of the more common development tools, such as Microsoft Visual Studio.Net, Borland Delphi, C ++ Builder, or J2EE (Java2 P1atform Enterprise Edition) and so on.
2.3 development and implementation of process management software project requirements
2.3.1 software project implementation process, the general requirements
（一）开发者提交软件开发工作大纲，交通局组织专家组对工作大纲进行评审，并提出整改意见。
（二）通过评审后，开发者根据整改意见完善工作大纲，经过交通局认可后组织项目组进行软件开发。软件开发工作按照需求分析、概要设计、详细设计、编码、测试等几个阶段进行，在开发过程中，开发者需分阶段提交相关文档。
（三）在软件开发工作完成后，开发者应向交通局提交完整的软件文档，交通局组织验收组对软件进行验收审查。
2.3.2 software project requirements change
In the development process, requirements or design changes need to happen inevitably, those changes must agree in writing before proceeding through the Department of Transportation. When requirements or design changes, the need to modify the original document, and provide a complete change history, so that changes in the state's control. Change order in the following table:
2.3.3 software project implementation milestones control
Department of Transportation will be divided into four stages check, to convene an expert review meeting.
（一） 需求分析（结合原型进行审查）确认；
（二） 概要设计+数据库设计；
（三） 预验收（试运行后）；
（四） 正式验收（推广使用后）。
- Software Development
After signing the contract, the project undertaking unit to organize the project team for software development work. Software development must be in strict accordance with the requirements of software engineering. Development process includes activities and tasks developers. This process is analyzed by the software requirements, outline design, detailed design, coding, testing, inspection, appraisal and other activities make up.
3.1 Software requirements analysis
3.1.1 Requirements Analysis
First, developers should work together for the Department of Transportation and Department of Transportation applications for full investigation, submit a complete needs analysis. The basic problem must be described in the needs analysis report are: functionality, performance, design constraints imposed on implementation, attributes, external interfaces. You should avoid writing the needs analysis in the design or project requirements. It must describe the results obtained by the software, not the means to obtain these results.
Software requirements can be expressed in several ways, such as by input and output instructions; representative example of the use; with standardized model. Developers should use the model of the way as much as possible, because it is precise and effective way to express complex needs. For example, using the Unified Modeling Language (UML) to describe requirements.
It requires analytical reports needs
a. No ambiguity
For each of the characteristics of the final product is described by a term; has more than one meaning if certain terms are used in a particular wording, then deal with the meaning of each term to explain and point out an appropriate use.
b. Integrity
Needs analysis should include all meaningful requirements, whether it is related to the functions, performance, design constraints or requirements related to the external interface aspects; to be defined for all possible responses of the input data, and to be legitimate lawful made in response to a predetermined input value; fill all the illustrations, tables, and other numerals shown; definitions of all terms and units of measure.
c. Verifiability
Each report describes a needs analysis needs should be verifiable. You can check the software product meets the demand through a limited process.
d. consistency
Description of each requirement in the needs analysis report can not contradict each other.
e. Modifiability
Needs analysis should have a methodical, content organization easy to use; no redundancy, that is not the same demand appears more than once in the needs analysis report.
f. Traceability
Origin of each requirement must be clear, when further documentation is generated and change, you can easily cite every need.
g. Operation and maintenance phase of usability
Needs analysis report must meet the needs of the operation and maintenance phase. In the needs analysis should specify the source and destination functions.
Preparers needs analysis report 3.1.2
Needs analysis report shall be the Department of Transportation and developers jointly completed. Where: Department of Transportation is responsible for the actual needs expressed the hope that software functionality; software developers based on the performance requirements of the Department of Transportation proposed combination of written software development needs analysis.
3.1.3 needs assessment report
After completion of software requirements analysis, software developers should be submitted to the Department of Transportation "Software Requirements Analysis Report." Department of Transportation personnel organizations about the need for review to determine whether the software needs improvement and appropriate. After the review is complete, you can enter the design phase of the software.
3.1.4 demand report format
"Software Requirements Analysis Report" basis having a certain format to write, to write the template shown in Appendix specific "software needs analysis" document A.
3.2 Summary of software design
3.2.1 Design Summary
In the Department of Transportation and the developers agreed by both parties "needs analysis" basis, under the developers to - work step. First, developers need to conduct preliminary design of the software system, that system design. SUMMARY design needs to design software systems considered in a system including the basic process flow, organizational structure of the system, module division, function allocation, interface design, operation design, data structure design and error handling design, provide detailed design software basis.
Written summary of the design requirements of 3.2.2
a. consistency
Summary of design requirements should be consistent with the needs and requirements analysis described in the report. At the same time, it should be consistency between the requirements of the outline design.
b. rationality
Summary of the proposed design method and design standards should be reasonable and appropriate.
c. Traceability
A summary of the requirements of the proposed design should be able to get it clear origins, namely customer needs analysis report has a clear requirements specification.
d. feasibility
Detailed design, operation and maintenance should be feasible according to the outline design.
3.2.3 writers outline design report
Outline design report prepared by the developer in accordance with the requirements analysis needs.
3.2.4 Summary of design and requirements analysis, the relationship and differences between the detailed design
Needs analysis does not involve specific technical implementation, and outline design focus on coming up out of the macro framework and describe what techniques employed methods to achieve these requirements. Detailed design is relatively more emphasis on the design outline design within the framework of the micro and is encoded in accordance with. Summary of design is based on the detailed design of the guidance.
3.2.5 Summary of design review
After the software outline design work is completed, the software developer should submit traffic "software system design report summary." After the Department of Transportation on the "Design Summary Report" review by, you can enter the detailed design stage.
3.2.6 Summary of design format
"Software System outline design report" basis having a certain format to write, specific "software system design Summary Report" document authoring templates, see Appendix B.
Detailed Design 3.3 Software
3.3.1 detailed design
On the basis of the outline design, detailed design of software developers need to be systematic. In the detailed design, particular algorithms described achieve the main modules involved, data structures, and calls the hierarchical relationship classes, a description of the software system at all levels of each program (each module or subroutine) design considerations, for coding and testing. It should ensure that the needs of the software is fully allocated to the software. Detailed design sufficient detail can be encoded in accordance with the detailed design report.
3.3.2 special case
If the software system is relatively simple, low-level, do not have to be specially detailed design, and outline design together.
3.3.3 detailed design requirements
a. consistency
Detailed design requirements and needs analysis needs to be described in the report, consistent with the outline design. At the same time, between the requirements of the detailed design should be consistent.
b. rationality
Detailed design of the proposed design methods and standards should be reasonable and appropriate.
c. Traceability
For the detailed design of the proposed requirements should be able to get it clear origins, to the needs analysis, preliminary design report, there is a clear demand description.
d. feasibility
Code, test, operation and maintenance should be possible based on detailed design.
3.3.4 Database Design
If you need to use a database software product, software detailed design should include the design of the database. Database design software should demand analysis, after the completion of the outline design, detailed design work carried out before the other. During the database design should be in accordance with the Department of Transportation to develop a "Nanjing Department of Transportation information database construction standard" requirement.
3.3.5 detailed design review
After the completion of the detailed design software, software developers should be submitted to the Department of Transportation "Software System Database Design Report" and "software system detailed design report." After the Department of Transportation to "Software System Database Design Report", "software system detailed design report" accreditation through, you can enter the software coding stage.
3.3.6 detailed design format
"Software system detailed design report", "Software System Database Design Report" basis having a certain format to write, specific "software system detailed design report" document authoring template and the "Software System Database Design Report" document authoring templates, see Appendix C Appendix D.
3.4 software coding
3.4.1 software coding
In the software coding stage, the developer according to design requirements "software system detailed design report" data structures, algorithms, analysis, and modules implement other aspects of the beginning of specific programming work, respectively, to achieve the function of each module, in order to achieve the target system aspects of function, performance, interfaces, interface requirements.
3.4.2 software coding requirements
a. Modular coding
b. Code readability
c. Maintainability
d. Module interface standardization
e. Unified interface style
e. The application notes
3.4.3 encoded review
In order to find as soon as possible in the software barriers and improve the quality of software products, developers in the encoding process should be emphasized that the code review work. The code review reports as part of the document, submitted to the Department of Transportation.
3.4.4 programming specifications and requirements
To improve the quality of programming, software programming programming must comply with the relevant norms issued by the State.
The main contents include: standardized procedures internal documents detailing the structure of the data, clear sentence structure, coding standards. Content-Encoding Specification includes naming conventions, interface specification, tips and help information practices, hotkey definitions.
Which part of the database should comply with the "Nanjing Department of Transportation information database construction norms" requirements.
Shall be tested at the same time means of software code.
3.5 Software Testing
3.5.1 software testing
U2FsdGVkX1+49E9dnJN+zt3yVXb7pFchHTTbqX8ov5FLkgFtLnuAnPvsv3zr762e
A6kZnja8xORlrQESAVrH846PE4SDcMTOHdmYuI5kqb8ka5INi3WxUvFKjlDhq5wf
H4m8PVbNaI4GTwsa4pV0ZYXZmbKBjXIOUi1gLkMyTXnDvV6dar+aoRihZc2TDQ9u
1sEsp+0o+TTomdpzQE4iMN8KFdt75f5UxjL6acN2IKdbLvHkC3fnIAMbhaOkZOTD
Bp77mINHCnlrSJrILiKbD28BbW/ww6Hip0mPyA8ipsd8VreWMEwcqxDgofcQNHlT
uqEnDFzOW+oqRGUyZV9PFF1Sf8iveTWza4cmXLZlK9vl3flovuXZFaye8pBLjwOl
In order to find a software product errors as early as possible, so as to improve software quality and reduce the cost of software maintenance, the developer should be unit tested program code for each module in the encoding process, integration testing during system integration, the system integration completed the entire software system testing. Unit testing is testing the correctness of program modules for the software development process. Integration testing unit test is based on the design requirements of all modules to be assembled in the system or subsystem, and a module assembly process for verifying the correctness of the module interface. Software testing is not only the overall behavior detection software performance, from the other side, is another confirmation of the software development and design. When the software system testing. Testing includes interface testing, usability testing, functional testing, stability (strength) test, performance test, robustness (recovery) test, the test logic, destructive testing, security testing.
