Code of practice from requirements documents to design documents (i)

1. Preface

This article has two objectives: to implement a nightly build platform and to explore the writing specifications of a software from requirements documents to design documents.

Every night, construction is a valuable tool in software research and development management, which is very important for speeding up discovering and correcting defects, reducing integration risk, improving product quality, enhancing members ' communication and cooperation, shortening time-to-market of products, increasing transparency of project development and enhancing confidence and morale of project team members. From the software engineering process: requirements definition, analysis, design to describe the actual combat every night to build a platform for most of the process.

The Chinese file of software engineering has a very important position, good document style and custom is an important symbol of the team mature. At present, some software developers, especially those just on the job, do not have a unified concept of document writing, they do not know the need to write those documents, they do not know how each document needs to write to the extent, a mention of the document to grab the ear and cheek. This article attempts to provide a sample document in this area, I do not think my document is very good, only hope to play a useful role.

To achieve these two goals, this article first explains the nightly build, gives the reader a clearer idea of the term, and then uses the use case writing technique in the write effective use case to create a platform-per-night use case and attach other related requirements to form a relative requirement definition document And then use the Object-oriented system analysis method to analyze the problem space of the requirement definition, construct the analysis model; for the reader to understand the design better and faster, a whole section of relevant open source or Third-party technical introduction, similar to "Hello World" introduction, also has the essence of content analysis, and note that the reminder And then the design of the platform two systems.

The entire nightly build platform includes two subsystems: building the system and building the information display system. Build the system with ant build script implementation, build information display system is a typical Web application. Both of them adopt object-oriented analysis and design techniques.

The reading of requirements definition should be user-oriented, supplemented by document writers, the sign of the requirement definition is that the two are agreed; The analysis section should be read by the document writer to help the user to read, to make the user understand and believe that the analysis model can solve the user's problem; The reading of the design chapter is mainly the system implementation, besides the requirement can be realized. , the design model also has strong inheritance and consistency with the analysis model.

The entire document is divided into the next three, the last chapter is about the requirements definition and analysis model.

2. The definition and function of each night's construction

The build is to remove all the latest code from a development software project from the code base, put it under a clean environment, compile the source code files, connect, install and test, and record the action series of all the logs throughout the process.

Building a platform is a system for building and building information display.

The construction of each night mainly refers to do not interfere with the developer's normal development work in the case of less intense development activities, and make sure to perform the construction once every day.

The role of the nightly builds is mentioned in the CVS and Nightlybuild technology book:

Part of the results of each module to integrate a part of the results can greatly reduce the risk of integration, strengthen the diagnosis of coordination between the modules, reduce the uncertainty of the whole system, can better locate the error to speed up the development speed, and promote the interface between modules to enhance teamwork, New systems every day. The new score is an important incentive for each member of the project team.

In addition to these roles, we can provide additional information for project management from a nightly build:

The products that are built every night, the records of the construction process per night, the test records in the construction process per night, the test coverage analysis of test quality, the contribution of project team members in the construction object and the project composition analysis (this article is called Project Metrics).