Software Engineering-project development documentation (module development instructions)

Module Development instructions

1. Title

[System name and identifier]

[Module name and identifier]

[Programmer signature]

[Change the document serial number of the file]

[Modification completion date]

[File No.]

[Orchestration date]

2. module development status table

[……]

3. Function Description

[Briefly describe the functions of this module, mainly the processing and output of input and requirements. This can be Excerpted from the System Design Manual. At the same time, it lists the chapters, sections, and sections of the description of these functions in the requirement manual.]

4. Design Description

[Describe the design considerations of this module]

5. Hardware design results

1) One hardware finished product that has been debugged by the project team

2) design file:

Schematic diagram

PCB diagram

Bom list

Programmable Devices and burn-in files

Detailed description on the waveform or hardware indicators of necessary test points

Detailed Principles

Detailed description of software and hardware of other interfaces in the system

These files can be appended to the form column.

6. Software Design Results

The first source code list of the generated module without syntax errors and the currently valid source code that has passed all tests should be provided.

7. Test Description

Note that each test in this module is required, including the identifiers and numbers of the tests, the purpose of the tests, the configurations and inputs used, the expected outputs, and the actual outputs.

8. Conclusion of review

Compare the actual test results with the requirements specified in the requirement specification and system design specification and draw a conclusion.