Software Development Document Template (Learning)

 1 Feasibility study 
　　report The purpose of the feasibility study report is to: describe the feasibility of the realization of the software development project in terms of technical, economic and social conditions; Justify the chosen option. 
The requirements for the preparation of the feasibility study report are as follows: 
　　1.1 Introduction 
　　1.1.1 Purpose of preparation 
　　1.1.2 Background 
　　1.1.3 Definition 
　　1.1.4 Reference materials 
　　1.2 Premise of feasibility study 
　　1.2.1 Requirements 
　　1.2.2 Objectives 
　　1.2.3 Conditions and assumptions 1.2.4 Methods of 
　　conducting feasibility studies 
　　1.2.5 Evaluation criteria 
　　1.3 Analysis of existing systems 
　　1.3.1 Data flow and processing flow 
　　1.3.2 Workload 
　　1.3.3 Expenses 
　　1.3.4 Personnel 
　　1.3.5 Equipment 
　　1.3 .6 Limitations 
　　1.4 Proposed System 
　　1.4.1 Description of Proposed System 
　　1.4.2 Data Flow Each Processing Flow 
　　1.4.3 Improvements 
　　1.4.4 Impact 
　　1.4.4.1 Impact on Target Equipment 
　　1.4.4.2 Impact on Software 
　　1.4.4.3 Impact on User Organizations 
　　1.4.4.4 Implications for system actions 1.4.4.5 Implications 
　　for development 
　　1.4.4.6 Implications for location and facilities 
　　1.4.4.7 Implications for financial expenditure 
　　1.4.5 Limitations 
　　1.4.6 Feasibility in terms of technical conditions 
　　1.5 Optional Other system solutions 
　　1.5.1 Optional system solution 1
　　1.5.2 Optional system solution 2
　　 ……
　　1.6 Investment and benefit analysis 
　　1.6.1 Expenditure 
　　1.6.1.1 Capital construction investment 
　　1.6.1.2 Other one-time expenditures 
　　1.6.1.3 Non-one-time
　　1.6.2 Income 
　　1.6.2.1 One-off Income  1.6.2.2 
　　Non-One-time Income 
　　1.6.2.3 Unquantifiable Income 
　　1.6.3 Income/Investment Ratio 
　　1.6.4 Investment Payback Period 
　　1.6.5 Sensitivity Analysis 
　　1.7 Social Conditions Feasibility 
　　1.7.1 Legal Feasibility 
　　1.7.2 Utilization Feasibility 
　　1.8 Conclusion 
2 Project Development Plan 
　　The purpose of compiling the project development plan is to use the form of documents to make arrangements and record the personnel in charge of each work in the development process, the budget required for the development progress, the required software and hardware conditions, etc., so that the development can be carried out according to this plan. and check the development work of this project. The content requirements are as follows: 
　　2.1 Introduction 
　　2.1.1 Writing purpose 
　　2.1.2 Background 
　　2.1.3 Definition 
　　2.1.4 Reference materials 
　　2.2 Project overview 
　　2.2.1 Work content 
　　2.2.2 Main participants 
　　2.2.3 Products and results 
　　2.2.3.1 Procedures 
　　2.2 .3.2 Documentation 
　　2.2.3.3 Services 
　　2.2.3.4 Non-Transfer Products 
　　2.2.4 Acceptance Criteria 
　　2.2.5 Deadlines for Project Completion 
　　2.2.6 Reviewers and Approvers of 
　　the Plan 2.3 Implementation Master Plan 
　　2.3.1 Breakdown of Work Tasks 
　　2.3 .2 Interface personnel 
　　2.3.3 Schedule 
　　2.3.4 Budget 
　　2.3.5 Key issues 
　　2.4 Support conditions 
　　2.4.1 Computer system support 
　　2.4.2 Work that needs to be undertaken by users 
　　2.4.3 Conditions that need to be provided by external units 
　　2.5 Thematic plan points 
3 Software Requirements specification 
　　The preparation of the software requirements specification is to make the user and the software developers have a common understanding of the initial provisions of the software, making it the basis of the entire development work. The content requirements for preparing a software requirements specification are as follows: 
　　3.1 Introduction 
　　3.1.1 Purpose of writing 
　　3.1.2 Background 
　　3.1.3 Definition 
　　3.1.1 References 
　　3.2 Task overview 
　　3.2.1 Objectives 
　　3.2.2 User's point 
　　3.2.3 Assumptions and constraints 
　　3.3 Requirements 
　　Specification 3.3.1 Function Specification 
　　3.3.2 Performance Specification 
　　3.3.2.1 Accuracy 
　　3.3.2.2 Time Characteristic Requirements 
　　3.3.2.3 Flexibility 
　　3.3.3 Input 
　　and Output Requirements 3.3.4 Data Management Capability Requirements 
　　3.3.5 Troubleshooting Requirements 
　　3.3.6 Other specific requirements 
　　3.4 Operating environment specification 
　　3.4.1 Equipment 
　　3.4.2 Support software 
　　3.4.3 Interfaces 
　　3.4.4 Control 
4 Data requirements 
　　specification Description and technical information of data collection requirements. The content requirements for the preparation of the data requirements statement are as follows: 
　　4.1 Introduction 
　　4.1.1 Purpose of Writing 
　　4.1.2 Background 
　　4.1.3 Definition 
　　4.1.4 References 
　　4.2 Logical Description of 
　　Data 4.2.1 Static Data 
　　4.2.2 Dynamic Input Data 
　　4.2.3 Dynamic Output Data 
　　4.2.4 Internally Generated Data 
　　4.2.5 Data Convention 
　　4.3 Data collection 
　　4.3.1 Requirements and scope 
　　4.3.2 Input bearer 
　　4.3.3 Processing 
　　4.3.4 Influence 
5 Outline design specification 
　　Outline design specification can be called system design specification. The purpose is to explain the design considerations for the program system, including the basic processing flow of the program system, the organization structure of the program system, module division, function allocation, interface design, operation design, data structure design and error handling design, etc. Detailed design provides the basis. The content requirements for the preparation of the general design specification are as follows: 
　　5.1 Introduction 
　　5.1.1 Purpose of preparation 
　　5.1.2 Background 
　　5.1.3 Definition 
　　5.1.4 Reference materials 
　　5.2 Overall design 
　　5.2.1 Requirements specification 
　　5.2.2 Operating environment 
　　5.2.3 Basic design concepts and processing Process 
　　5.2.4 Structure 
　　5.2.5 Relationship between functional requirements and procedures 
　　5.2.6 Manual processing 
　　5.2.7 Unsolved problems 
　　5.3 Interface design 
　　5.3.1 User interface 
　　5.3.2 Internal interface 
　　5.3.3 External interface 
　　5.4 Operation design 
　　5.4.1 Operation module combination 
　　5.4.2 Operation control 
　　5.4.3 Operation time 
　　5.5 System data structure design 
　　5.5.1 Logical structure design points 
　　5.5.2 Physical structure design points 
　　5.5.3 Relationship between data structure and program 
　　5.6 System error handling design 
　　5.6.1 Error message 
　　5.6.2 Remedial measures 
　　5.6.3 System maintenance design 
6 Detailed Design Specifications 
　　Detailed specifications may be referred to as programming specifications. The purpose of compilation is to explain the design considerations of each program (each module or subprogram) in each level of a software system. If a software system is relatively simple and has few levels, this document may not be written separately, and the relevant content is combined with the outline design specification. .
　　6.1 Introduction 
　　6.1.1 Purpose of writing 
　　6.1.2 Background 
　　6.1.3 Definitions 
　　6.1.4 References 
　　6.2 Organizational structure of program system 
　　6.3 Program 1 (identifier) ​​design specification  6.3.1 
　　Program description 
　　6.3.2 Functions 
　　6.3.3 Performance 
　　6.3.4 Inputs 
　　6.3.5 Outputs 
　　6.3.6 Algorithms 
　　6.3.7 Flow Logic 
　　6.3.8 Interfaces 
　　6.3.9 Storage Allocation 
　　6.3.10 Annotation Design 
　　6.3.11 Constraints 
　　6.3.12 Tests Program 
　　6.3.13 Unresolved Issues 
　　6.4 Program 2 (Identifier) ​​Design Specification 
　　 ...
7 Database Design 
　　Specification The purpose of the database design specification is to make specific design regulations for all the identification, logical structure and logical structure of the database in the design. Its content requirements are as follows: 
　　7.1 Introduction 
　　7.1.1 Purpose of writing 
　　7.1.2 Background 
　　7.1.3 Definitions 
　　7.1.4 References 
　　7.2 External design 
　　7.2.1 Identifiers and states 
　　7.2.2 Programs that use it 
　　7.2.3 Conventions 
　　7.2.4 Special Guidance 
　　7.2.5 Supporting Software 
　　7.3 Structural Design 
　　7.3.1 Conceptual Structural Design 
　　7.3.2 Logical Structural Design 
　　7.3.3 Physical Structural Design 
　　7.4 Application Design 
　　7.4.1 Data Dictionary Design 
　　7.4.2 Security and Confidentiality Design 
8 User's Manual 
　　The user's manual should be prepared using non-specialized terminology language to fully describe the functions and basic usage of the software system engineering. This manual enables the user (or potential user) to understand the purpose of the software and to determine under what circumstances and how to use it. The specific content requirements are as follows: 
　　8.1 Introduction 
　　8.1.1 Purpose of writing 
　　8.1.2 Background 
　　8.1.3 Definition 
　　8.1.4 References 
　　8.2 Purpose 
　　8.2.1 Function 
　　8.2.2 Performance 
　　8.2.2.1 Accuracy 
　　8.2.2.2 Time characteristics 
　　8.2.2.3 Flexibility 
　　8.2.3 Security and confidentiality 
　　8.3 Operating environment 
　　8.3.1 Hardware device 
　　8.3.2 Support software 
　　8.3.3 Data structure 
　　8.4 Use process 
　　8.4.1 Installation and initialization 
　　8.4.2 Input 
　　8.4.2.1 Realistic background of input data 
　　8.4.2.2 Input format 
　　8.4 .2.3 Input example 
　　8.4.3 Output 
　　8.4.3.1 Realistic background of output data 
　　8.4.3.2 Output format 
　　8.4.3.3 Output example 
　　8.4.4 File query 
　　8.4.5 Error handling and recovery 
　　8.4.6 Terminal operation 
9 Operation 
manual The preparation of the operation manual is to provide the operator with the specific process of each operation of the software and relevant knowledge, including details of how to do it. The specific content requirements are as follows: 
　　9.1 Introduction 
　　9.1.1 Purpose of writing 
　　9.1.2 Background 
　　9.1.3 Definition 
　　9.1.2 Reference materials 
　　9.2 Software overview 
　　9.2.1 Software structure 
　　9.2.2 Program table 
　　9.2.3 File table 
　　9.3 Installation and initialization 
　　9.4 Operation Description 
　　9.4.1 Operation Table 
　　9.4.2 Operation Step 
　　9.4.3 Operation 1 (Identifier) ​​Description 
　　9.4.3.1 Operation Control 
　　9.4.3.2 Operation Information 
　　9.4.3.3 Input-Output  File
　　9.4.3.4  Output File
　　9.4.3.5 Copy of output segment 
　　9.4.3.6 Initiate recovery procedure 
　　9.4.4 Run 2 (identifier) ​​description 
　　9.5 Non-routine procedure 
　　9.6 Remote operation 
10 Module development dossier 
　　The module development dossier is written step by step in the module development process. One copy is prepared each time a module or a closely related module is reviewed, and all the module development dossiers should be brought together. The purpose of writing is to record and summarize the progress and results of low-level development, so as to facilitate the management and review of the entire module development work, and to provide very useful technical information for future maintenance. The specific content requirements are as follows: 
　　10.1 Title 
　　10.2 Module development table 
　　10.3 Functional description 
　　10.4 Design description 
　　10.5 Source code listing 
　　10.6 Test description 
　　10.7 Review conclusion 
11 Test plan 
　　11.1 Introduction 
　　11.1.1 Writing purpose 
　　11.1.2 Background 
　　11.1.3 Definition 
　　11.1. 4 References 
　　11.2 Planning 
　　11.2.1 Software Description 
　　11.2.2 Test Content 
　　11.2.3 Test 1 (Identifier) 
　　​​11.2.3.1 Scheduling 
　　11.2.3.2 Conditions 
　　11.2.3.3 Test Data 
　　11.2.3.4 Test Training 
　　11.2.4 Test 2 (Identifier) 
　　 ​​ …
　　11.3 Test Design Instructions 
　　11.3.1 Test 1 (Identifier) 
　　11.3.1.1 Control 
　　11.3.1.2 Input 
　　11.3.1.3 Output 
　　11.3.1.4 Process 
　　11.3.2 Test 2 (Identifier) 
　　 ​​ …
　　11.4 Evaluation Criteria 
　　11.4.1 Scope 
　　11.4.2 Data Collation 
　　11.4.3 Scale 
12 Test Analysis Report  The test analysis 　　report 
　　is written for the purpose of documenting the results, findings and analysis of the assembly test and 
　　validation  　　test  　　. 3 Definitions  　　12.1.4 References  　　12.2 Measure Summary  　　12.3 Test Results and Findings  　　12.3.1 Test 1 (Identifier)  　　​​12.3.2 Test 2 (Identifier)  　　 ​​... 　　12.4 Conclusions on Software Function  　　12.4.1 Function 1 (Identifier)  　　12.4.1.1 Capabilities  　　12.4.1.2 Limitations  　　12.4.2 Capability 2 (Identifier) 　　 ​​ … 　　12.5 Analysis Summary  　　12.5.1 Capabilities  　　12.5.2 Defects and Limitations 


















　　12.5.3 Recommendation 
　　12.5.4 Evaluation 
　　12.6 Test Resource Consumption 
13 Monthly 
　　Development Progress Report The purpose of preparing the monthly development progress report is to report the progress and situation of the project development to the relevant management department in a timely manner, so as to timely discover or deal with the problems in the development process . Generally, the monthly development progress report is prepared on a monthly basis by the project team. If the scale of the software system to be developed is relatively large, the entire engineering project is divided into several sub-project teams to undertake, and the monthly development progress report will be prepared on a monthly basis by the project team. The specific content requirements are as follows: 
　　13.1 Title 
　　13.2 Project Progress and Status 
　　13.2.1 Progress 
　　13.2.2 Status 
　　13.3 Resource Consumption and Status 
　　13.3.1 Resource Consumption 
　　13.3.1 .1 Work Hours 
　　13.3.1 .2 Timing 
　　13.3.2 Status 
　　13.4 Expenditure and Status 
　　13.4.1 Expenditure 
　　13.4.1 .1 Support Expenses 
　　13.4.1 .2 Equipment Purchase Expenses 
　　13.4.2 Status 
　　13.5 Work Plan for Next  Month
　　13.6 Recommendation 
14 Project Development Summary Report 
　　Preparation of Project Development Summary Report It is to summarize the experience of the development work of this project, to explain the actual development results and the evaluation of all aspects of the whole development work. The specific content requirements are as follows: 
　　14.1 Introduction 
　　14.1.1 Purpose of writing 
　　14.1.2 Background 
　　14.1.3 Definition 
　　14.1.4 References 
　　14.2 Actual Development Results 
　　14.2.1 Product 
　　14.2.2 Main Function and Performance 
　　14.2.3 Basic Process 
　　14.2.4 Schedule 
　　14.2.5 Cost 
　　14.3 Development Work Evaluation 
　　14.3.1 Production Evaluation of efficiency 
　　14.3.2 Evaluation of product quality 
　　14.3.3 Evaluation of technical methods 
　　14.3.4 Analysis of error causes 
　　14.4 Experience and lessons learned.