How to write php software development documentation

How to write PHP software development documents?

1Title
Software system name and identifier
Module name and identifier (if this dossier contains more than one module, use the function identifier of this group of modules instead of the module name)
Programmer's signature
Dossier's modified text serial number
Modification completion date
Dossier serial number (indicates the serial number of this dossier in the entire dossier)
Arrangement date (indicates the most recent arrangement date of the entire dossier)

2 Module development status table

3 Function Description
Briefly describe the functions of this module (or this group of modules), mainly input, request processing, and output. Can be excerpted from the system design specification. Also list the chapters, clauses, and clauses that describe these functions in the software requirements specification.
4 Design Description
Describe the design considerations of this module (or this group of modules), including:
a. The description of the design considerations for this module (or this group of modules) in the system design specification, including the level of this module in the software system and its interface with other modules;
b. The design considerations for this module (or this group of modules) in the programming instructions include the algorithm, processing flow, involved data file design limitations, driving methods and error messages of this module;
c. Design considerations that were actually used when compiling source code that has now passed all tests.
5Original code list
The first source code list without syntax errors of this module (or this group of modules) generated and the currently valid source code that has passed all tests must be given. Code listing.
6Test Description
Describe each test that directly passes through this module (or this group of modules), including the respective identifiers and numbers of these tests, the purpose of these tests, and the methods used. Configuration and input, expected output and actual output.
7 Conclusion of the review
Compare the actual test results with the requirements specified in the software requirements specification, system design specification, and program design specification and give a conclusion.

The above is the detailed content of How to write php software development documentation. For more information, please follow other related articles on the PHP Chinese website!