Ich würde gerne fragen, ob es in Ihrem Team Unterlagen gibt? Für welche Inhalte ist eine spezielle Dokumentation erforderlich?

Ich schreibe seit mehr als einem Jahr Programme von Grund auf in einem Startup-Unternehmen. Jetzt möchte mein Chef es dokumentieren, damit Neulinge schnell mit dem Projekt beginnen können . Vielleicht schreiben Sie es ein. Nach einer Weile wurde der Code von anderen Kollegen geändert und die Dokumentation war falsch. Was soll ich schreiben?

Antwortinhalt:

Ich schreibe seit mehr als einem Jahr Programme von Grund auf in einem Startup-Unternehmen. Jetzt möchte mein Chef es dokumentieren, damit Neulinge schnell mit dem Projekt beginnen können . Vielleicht schreiben Sie es ein. Nach einer Weile wurde der Code von anderen Kollegen geändert und die Dokumentation war falsch. Was soll ich schreiben?

1. Codeänderungsdatensatz

2. Datenbankänderungsdatensatz

3. Probleme und Lösungen

4. Wenn ein Kollege Änderungen vornimmt, bitten Sie ihn, die Aktualisierung auf der Rückseite des Dokuments vorzunehmen, ersetzen Sie es nicht direkt

Ich denke, es ist besser, zunächst den grundlegenden Prozess und die Spezifikationen der Projekte des Unternehmens zu erklären. Beispielsweise kennen Neulinge möglicherweise nicht unbedingt einige der bisherigen Arbeitsaufzeichnungen des Unternehmens und müssen am Ende doppelt arbeiten und herumspielen. Sie können zunächst kurz die grundlegende Einführung und die zugehörigen Links einiger in den Projekten des Unternehmens verwendeter Tools, Frameworks und Plattformen erläutern. Anschließend können Sie die Codierungsstandards, das grundlegende Geschäft, die Arbeitspläne (Todo) und die Codeverwaltung erläutern Der Arbeitsprozess wird erwähnt, um zu verhindern, dass Neulinge weiterhin in die Falle tappen. Schließlich können Sie Anfängern einige Technologie-Stacks empfehlen, die das Unternehmen betreffen und die sie kennenlernen müssen.

php Open Source DokuWiki

Das war ursprünglich eine Falle. Ich habe es nicht während der Entwicklung geschrieben und schreibe es jetzt.
Aber Sie können einige Referenzen angeben:
Systemdesigndokumente, Datenbankdesigndokumente, Schnittstellendesigndokumente, Website-Bereitstellungskonfigurationsdokumente, Website-Nutzungsanleitungsdokumente usw.