Wie schreibe ich eine Dokumentation zur PHP-Softwareentwicklung?

Wie schreibe ich PHP-Softwareentwicklungsdokumente?

1 Titel
Name und Kennung des Softwaresystems
Modulname und -kennung (wenn dieses Dossier mehr als ein Modul enthält, verwenden Sie die Funktionskennung dieser Modulgruppe anstelle des Modulnamens)
Unterschrift des Programmierers
Änderungstext-Seriennummer des Dossiers
Abschluss der Änderung Datum
Dossier-Seriennummer (gibt die Seriennummer dieses Dossiers im gesamten Dossier an)
Arrangement-Datum (gibt das aktuellste Arrangement-Datum des gesamten Dossiers an)

2 Modulentwicklungsstatus Tabelle

3 Funktionsbeschreibung
Beschreiben Sie kurz die Funktionen dieses Moduls (oder dieser Modulgruppe), hauptsächlich Eingabe, Verarbeitung von Anforderungen und Ausgabe. Kann der Systemdesignspezifikation entnommen werden. Listen Sie außerdem die Kapitel, Klauseln und Klauseln auf, die diese Funktionen in der Softwareanforderungsspezifikation beschreiben.
4 Designbeschreibung
Beschreiben Sie die Designüberlegungen dieses Moduls (oder dieser Modulgruppe), einschließlich:
a. Eine Beschreibung der Designüberlegungen für dieses Modul (oder diese Modulgruppe) in der Systemdesignspezifikation, einschließlich der Ebene dieses Moduls im Softwaresystem und seiner Schnittstelle zu anderen Modulen; Zu den Entwurfsüberlegungen für dieses Modul (oder diese Modulgruppe) in den Programmieranweisungen gehören der Algorithmus, der Verarbeitungsablauf, die Einschränkungen des Datendateidesigns, die Treibermethoden und Fehlermeldungen dieses Moduls
c. Designüberlegungen, die tatsächlich beim Kompilieren des Quellcodes berücksichtigt wurden, der nun alle Tests bestanden hat.

5 Originalcodeliste Als Code wird die erste Quellcodeliste ohne Syntaxfehler dieses Moduls (oder dieser Modulgruppe) erstellt und der aktuell gültige Quellcode, der alle Tests bestanden hat Auflistung.

6 TestbeschreibungBeschreiben Sie jeden Test, der dieses Modul (oder diese Modulgruppe) direkt durchläuft, einschließlich der jeweiligen Kennungen und Nummern dieser Tests, des Zwecks der Durchführung dieser Tests und die verwendeten Methoden Konfiguration und Eingabe, erwartete Ausgabe und tatsächliche Ausgabe.

7 Fazit der ÜberprüfungVergleichen Sie die tatsächlichen Testergebnisse mit den in der Softwareanforderungsspezifikation, der Systemdesignspezifikation und der Programmdesignspezifikation festgelegten Anforderungen und geben Sie eine Schlussfolgerung ab.

Das obige ist der detaillierte Inhalt vonWie schreibe ich eine Dokumentation zur PHP-Softwareentwicklung?. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!