Hintergrund
Nicht aufeinander abgestimmter Code und Dokumentation sind ein häufiges Problem bei der Softwareentwicklung, das zu einer ineffizienten Zusammenarbeit im Team führen kann und neuen Entwicklern den Einstieg erschwert. Da sich Projekte weiterentwickeln und Codeänderungen vorgenommen werden, kann die manuelle Pflege der Dokumentation zeitaufwändig sein und Aktualisierungen können leicht übersehen werden.
Zentrale Lösungen
DeepDocs löst das Problem der Dokumentensynchronisation auf folgende Weise:
- automatisierte PrüfungIntegration in GitHub-Workflows, automatische Überprüfung auf Änderungen nach jeder Code-Übertragung
- Intelligentes MatchingKI analysiert die Korrelation zwischen Code-Änderungen und vorhandener Dokumentation und ermittelt die Teile, die aktualisiert werden müssen.
- beibehaltenes FormatDie ursprüngliche Markdown-Formatierung und der Stil bleiben erhalten, wenn der Inhalt eines Dokuments aktualisiert wird.
- Versionskontrolle freundlichEinreichen von Aktualisierungen durch Erstellung eines separaten Zweigs zur einfachen Überprüfung durch das Team
Verfahren
- Installieren Sie die DeepDocs-GitHub-Anwendung und konfigurieren Sie die überwachten Code-Repositories
- Erstellen Sie die Konfigurationsdatei deepdocs.yml im Stammverzeichnis des Projekts
- Erstes Scannen für vollständige Dokumentensynchronisation auslösen
- Automatisch inkrementelle Aktualisierungen bei nachfolgenden Codeübertragungen einleiten
caveat
Erstanwender müssen sicherstellen, dass das Projekt bereits über grundlegende Dokumente verfügt, denn DeepDocs konzentriert sich eher auf die Aktualisierung als auf die Erstellung neuer Dokumente. Bei Projekten mit mehreren Repositories müssen Sie die Anwendung auf allen relevanten Repositories installieren.
Diese Antwort stammt aus dem ArtikelDeepDocs: das GitHub-KI-Tool zur automatischen Aktualisierung der Code-DokumentationDie
