Today, software development is increasingly complex, and software functions are getting richer. Almost all mature business software is crystallized by hard-earned sweats in a development team. "Rome is not built!" When we shocked the shocking masterpieces of Microsoft Windows, he also said that Microsoft's software engineering is improved. Indeed, a number of joint efforts of hundreds of employees have been gather in several years, and the success or failure of software project management is a key link for controlling development costs. This is less than the important steps running through ---- Software documentation.
Software documents can be divided into two categories: development documents and product documents.
The development documentation includes: "Feature Requirements", "Bidding Scheme", "Demand Analysis", "Technical Analysis", "System Analysis", "Database Document", "Function Function Document", "Interface Document", "Compile Manual", "QA document", "project summary", etc.
Product documentation includes: "Product Introduction", "Product Demonstration", "Question", "Features", "Technology White Paper", "Evaluation Report", "Installation Manual", "Manual", "Maintenance Manual", " User Report, "Sales Training", etc.
First, development documentation
1. "Feature Requirements" - From the customer requirements and market surveys, it is the earliest part of software development. Customers present a fuzzy functional concept, or requires solving an actual problem, or refer to a function of the same software. Customers with software experience will also provide more detailed technical specifications, write their requirements all lists in the document, if necessary, the chart is said. This document is the basis for demand analysis.
2. "Bidding Scheme" - According to the user's functional requirements, after communication and confirmation with the bidding party, the technicians begin writing "bidding programs", and the program book generally includes the following important chapters:
Foreword - Project background, company background and business, technical staff structure, company success case introduction, etc.
Demand Analysis - Project Requirements, Software Structure, Function List, Function Description, Precautions, etc.
Technical solutions - overall requirements and guiding ideology, technical solutions, software development platforms, network structures, etc.
Project Management - Description Company's software development process, engineering implementation service, organization and personnel division, development schedule control, software quality assurance, project acceptance and personnel training, software data documentation, etc.
Technical Support - Company's technical support and service introduction, service tenet and target, service level and response time, technical service area, technical service period, authorized user contact, etc.
System quote - soft, hardware platform quotation list, software development fees, system maintenance costs, etc.
Project progress - the progress plan of the entire project, including signing contract, project launch, demand analysis, system analysis, program development, test maintenance, system integration, user acceptance, user training, etc. steps.
3. "Demand Analysis" - including product overview, main concepts, operational processes, function lists, precautions, system environments, etc. Based on "Features Requirements", the detailed function analysis (including the requirements of the customer and the implementation of the development experience), what is the product, what special concepts, including those feature classification, what features need to have What is the operation of this function, what is the details of the customer, what is the requirements of the customer, and the requirements of the system operation environment. The functional description here is consistent with the manual after the future.
4. "Technical Analysis" - including technical selection, technical comparison, developer, key technical problem solving, technical risk, technology upgrade direction, technical plan evaluation, competitor technical analysis, etc. Based on "Demand Analysis", a detailed technical analysis (product performance and implementation method) lists what technical solutions need to use, why, what technical issues should be solved, what difficulties encountered during the development period, How to upgrade after the technical solution, what evaluates for the technology of this project, etc.
5. System Analysis - includes functions, modules, functional flow charts, function interfaces, data dictionary, software development needs to be considered. Based on "Demand Analysis", the detailed system analysis (product development and implementation method), what problems need to be estimated during development, and programmers will begin to coding under the leadership of the project supervisor according to "System Analysis". 6. Database Database - including database name, table name, field name, field type, field description, note, field numerical calculation formula, etc. Detailed database design based on "System Analysis". If necessary, you can use the graphical solution, especially the relational database.
7. "Functional Document" - including variable names, variables, functions, function names, parameters, how to call, notes, notes, etc. Based on "System Analysis", the detailed description is performed, which features are listed to how many functions involved so that programmers will be modified, take over and extensions.
8. "Interface Document" - includes software appearance, interface material, editing tool, file name, menu, buttons, and other interface components, which is consistent with the running interface after software.
9. Compilation Manual - Includes the server compilation environment, operating system, compile tool, GNU's C compiler version information, directory instructions, program generation, source file list, makefile configuration, and related programs. The client's compilation process, compiling results, compile examples, compile environments, operating systems, compile tools, source file lists, and processes for making installations.
10. "QA Document" - including product introduction, product principle, product function list, function description, functional process, execution result, database structure, test requirements, etc., is provided to software testers.
11. "Summary of Projects" - including project introduction, project participants and development time, project risk management process, project function list, project structure characteristics, technical characteristics, upgrade recommendations for projects, recommendations for future projects, personnel quality The situation, etc.
Second, product documentation
1. "Product Introduction" - including the company's background, product concept, scope of application, product function, functional characteristics, operational requirements, and company contact address.
2. "Product Demo" - including company profile, product background, product description, product characteristics, product role, scope of application, analysis, function module, solution, partner, success case, etc. Generally implemented with Power Point or VCD recording software.
3. "Question Solution" - Lists the issues and processing methods of users concerning. Used to answer the operation function of the software and solve the problem of user troubleshooting.
4. "Feature Introduction" - Write the foundation with "Demand Analysis", including software introduction, software structure, function list, function description, and company contact address.
5. "Technical White Paper" - With the "technical analysis", the basis of writing, including functional implementation, technical selection, key technical issues, technical program characteristics, technical upgrade direction, etc.
6. "Report" - Third Party authority evaluation report. Including evaluation purposes, evaluation scope, evaluation environment, evaluation content, measured data, performance performance, results analysis, and evaluation summary.
7. "Installation Manual" - including system environment, run platform, product installation process, initial environment setting, installation record, etc.
8. "User Manual" - including product description, function list, function description, interpretation, functional operation, customer service, contact information, etc.
9. Maintenance Manual - Including product profile, system instructions, initial environment settings, system configuration, data management, and backup, technical issues, and contact information.
10. "User Report" - Includes product profile, purchase time, use purpose, use time, use place, implementation process, problem and resolution, product summary and suggestions.
11. "Sales Training" - including project introduction, product feature, product characteristics, commercial advantages, system operating environment, scope of application, target customers, etc.
