Comment rédiger une documentation de développement de logiciels PHP

Comment rédiger des documents de développement de logiciels php ?

1 Titre
Nom et identifiant du système logiciel
Nom et identifiant du module (si ce dossier contient plus d'un module, utiliser l'identifiant de fonction de ce groupe de modules à la place du nom du module)
Signature du programmeur
Texte de modification numéro de série du dossier
Achèvement de la modification date
Numéro de série du dossier (indique le numéro de série de ce dossier dans l'ensemble du dossier)
Date d'arrangement (indique la date d'arrangement la plus récente de l'ensemble du dossier)

2 Statut de développement du module Tableau

3 Description des fonctions
Décrivez brièvement les fonctions de ce module (ou de ce groupe de modules), principalement l'entrée, le traitement des exigences et la sortie. Peut être extrait de la spécification de conception du système. Répertoriez également les chapitres, clauses et clauses qui décrivent ces fonctions dans la spécification des exigences logicielles.
4 Description de la conception
Décrivez les considérations de conception de ce module (ou de ce groupe de modules), notamment :
a. Une description des considérations de conception pour ce module (ou ce groupe de modules) dans la spécification de conception du système, y compris le niveau de ce module dans le système logiciel et son interface avec d'autres modules
b. Les considérations de conception pour ce module (ou ce groupe de modules) dans les instructions de programmation incluent l'algorithme, le flux de traitement, les limitations de conception des fichiers de données impliqués, les méthodes de pilotage et les messages d'erreur de ce module ; Considérations de conception qui ont été réellement utilisées lors de la compilation du code source qui a désormais réussi tous les tests.

5 Liste de codes originaux La première liste de codes sources sans erreurs de syntaxe de ce module (ou de ce groupe de modules) générée et le code source actuellement valide qui a réussi tous les tests doit recevoir Code inscription.

6 Description des testsDécrire chaque test qui passe directement par ce module (ou ce groupe de modules), incluant les identifiants et numéros respectifs de ces tests, le but de la réalisation de ces tests, et les méthodes utilisées. Configuration et saisie, sortie attendue et sortie réelle.

7 Conclusion de l'examenComparez les résultats des tests réels avec les exigences spécifiées dans la spécification des exigences logicielles, la spécification de conception du système et la spécification de conception du programme et donnez une conclusion.

Ce qui précède est le contenu détaillé de. pour plus d'informations, suivez d'autres articles connexes sur le site Web de PHP en chinois!