Software Development Documentation

Software Development Documentation

Software development documentation is an essential part of the software development use and maintenance process. It can improve the efficiency of software development, ensure the quality of software, but also in the use of software guidance, help, the role of doubt, especially in the maintenance work, documentation is indispensable information.

Software documentation can be divided into two categories: development documentation and product documentation.

Development documents include: "Functional Requirements", "bidding scheme", "Demand Analysis", "Technical Analysis", "System Analysis", "Database Document", "Functional function Document", "Interface Document", "Compiling Manual", "QA Document", "project summary" and so on. Product documentation includes: "Product introduction", "Product demonstration", "question answer", "Function Introduction", "technical white Paper", "Evaluation report". User Documentation "Installation manual", "Manual", "Maintenance Manual", "User Report", "Sales training" and so on. Development Documentation1. "Functional Requirements"-from customer requirements and market research, is the earliest part of software development. The customer proposes a vague functional concept, or asks to solve a practical problem, or to refer to a function of the same kind of software. Customers with software experience will also be provided with a detailed technical specification, a full list of their requirements to be written in the document, if necessary, to explain the chart. This document is the basis of demand analysis. 2. Bidding programme-based on the user's functional requirements, after communication and confirmation with the tendering party, the technical staff began to write the "bidding scheme", the proposal generally includes the following important chapters: Preface-project background, company background and business, technical staff structure, the company's successful case introduction. Requirements Analysis--project requirements, software structure, function list, function description, precautions, etc. Technical Solutions-general requirements and guiding ideology, technical solutions, software development platform, network structure system. Project Management-describes the company's software development process, engineering implementation services, organizational and Personnel Division, Development progress Control, software quality assurance, project acceptance and personnel training, software documentation and so on. Technical Support--the company's technical support and service introduction, service objectives and objectives, service level and response time, technical service area, technical service period, authorized user contact and so on. System quotation--software and hardware platform quotation list, development cost, system maintenance cost, etc. Project Progress-the schedule of the whole project, including signing contract, project initiation, demand analysis, System analysis, program development, test maintenance, system integration, user acceptance, user training and other steps of the time plan. 3. Demand analysis-Includes product overview, key concepts, operating procedures, function lists and explanations, precautions, system environment, etc. Based on "Functional Requirements", perform detailed functional analysis (including customer requests and recommended features based on development experience), list what this product is, what special concepts are included, what functions are categorized, what functions are required, how the function is implemented, what details the customer needs to pay attention to, System operating environment requirements and so on. The functional descriptions here are consistent with the subsequent manuals. 4. "Technical analysis"-including technology selection, technical comparison, developers, key technical issues, technical risk, technology upgrade direction, technical program evaluation, competitor technical analysis. On the basis of "demand analysis" for detailed technical analysis (product performance and implementation methods), the list of what the project needs to use the technical solutions, why, what technical issues to solve, estimate the development of what difficulties encountered, how to upgrade the technical plan, how to evaluate the technology of the project and so on. 5. "System analysis"-including function realization, module composition, function flowchart, function interface, data dictionary, software development need to consider a variety of issues. "Demand Analysis"For the basis of detailed system analysis   (product development and implementation methods), estimating what issues need to be understood during development, the programmer began coding under the leadership of the project under the guidance of "system analysis". 6. Database documentation-includes database name, table name, field name, field type, field description, Comment, field numeric calculation formula, and so on. Based on "system Analysis", the detailed database design is carried out. If necessary, you can use a graphical commentary, especially a relational database. 7. Functional function Document-includes variable name, variable initial value, function, function name, parameters, how to call, notes, notes, etc. Based on "system Analysis", a detailed description of which function is involved in how many functions to be modified, inherited and extended by the programmer. 8. "Interface Documentation"-including the software appearance, interface material, editing tools, filenames, menus, buttons and other interface components requirements, here and the software after the completion of the operating interface is consistent. 9. Compiling manual--includes the server compilation environment, operating system, compilation tools, GNU c++  compiler version information, directory description, program generation, source program file list, Makefile configuration and its related programs list of correspondence. The process of compiling the client, compiling the results, compiling the sample, compiling the environment, operating system, compiling tools, List of source files, and authoring the installer. 10. QA documentation-including product introduction, product principle, product function list, function description, function flow, execution result, database structure, test requirements, etc., to be used by software testers. 11. Project summary-including project introduction, project participants and development time, project risk management process, Project function list, project structure characteristics, technical characteristics, proposals for project upgrade, suggestions for future projects, personnel quality, etc.   Product Documentation1. "Product Introduction"--including company background, product concept, scope of application, product function, functional characteristics, operational requirements and company contact address. 2. "Product demonstration"--including company profile, product background, product description, product characteristics, product function, scope of application, usage analysis, function module, problem solving, partner, success story, etc. Typically implemented with Power point or VCD recording software. 3. "Question Answer"--lists the user's concerns and handling methods. It is used to answer the operation function of the software and solve the problem of the user. 4. "Function Introduction"--based on "demand analysis", including software introduction, software structure, function list, function description and company contact address. 5. The technical white paper-based on technical analysis, including function realization, technology selection, solution of key technical problems, technical program features, technology upgrade direction, etc. 6. "Evaluation report"-Third party authoritative evaluation report. Including evaluation purposes, evaluation scope, evaluation environment, evaluation content, measured data, performance, results analysis and evaluation summary. 7. "Installation Manual"-including system environment, operating platform, product installation process, initial environment settings, installation records and so on. 8. User manual-Includes product brief, function list, function description and explanation, function operation, customer service and contact information. 9. Maintenance Manual-Includes product introduction, system instructions, initial environment settings, system configuration, data management and backup, technical questions and contact information, etc. 10. User report-Includes product introduction, time of purchase, purpose of use, time of use, place of application, implementation process, problem and resolution, product summary and recommendations, etc. 11. "Sales Training"--including project introduction, product features, product features, business advantages, system operating environment, scope of application, target customers and so on. Software Development DocumentationFirst, requirements Analysis document what is a user requirements analysis document? That is, in the communication with the customer, the user requirements of the information recorded, according to the requirements of the user analysis, planning the software we are developing to achieve what functions. Second, summary design document Summary design: As the name implies, is the software we want to develop a general summary, the software contains the function of the module as a design, we will have a goal in the development, there is direction. Third, the system design Document System design, is a detailed implementation of the summary, is to analyze the software we want to develop the major modules contained in the small module, these small modules are listed, and then the software developers to conduct a structured development task allocation. The detailed design document detailed design document, mainly is our each small module, the small function business logic processing uses the text expression, lets the programmer in the code time to have the basis and the reference, at the same time, when carries on the detailed document design, some software company also may according to the different project make the corresponding " Specification of software development code. To ensure the unity of our work. Software Test documents when we refer to the software detailed design document coding is completed, then we will be based on the functions of our implementation of the software test document writing; Most test documents have two types, one is software monomer test document, the other is software combined test document; Monomer test: Is the software in each small method, a separate method to test the document, combined with testing: is to combine multiple functional modules together for testing, mainly in order to detect each functional module before the interaction and function of the implementation of the combination. After the completion of the software summary reporting document regardless of the size of the software development, after a software development, we will be developed in the problems and project development summary record, in order to prevent later in the development process of similar problems arise, improve our development efficiency. According to the size of the software development company, standards and customer needs, the type and quantity of development documents are different, I here and you discuss the software development related documents are the most basic; in the software industry has a sentence: a software can be completed smoothly and the function is perfect, it is important to see how many documents this software, Software development documentation is the backbone of a software, if your development document is flawed, then the software you have developed can not be good, the development of the quality of the document may directly affect the development of the success of the software.

 

Software Development Documentation