Erstellen von Dokumentation mit Amazon Q Developer
Anmerkung
Sie können direkt im Chat nach dem Erstellen von Dokumentation fragen. Wenn Sie /doc verwenden, wird Ihre Anfrage an den Chat weitergeleitet. Formulieren Sie die Aufforderung generate documentation for my application.
Amazon Q Developer hilft Ihnen dabei, Ihren Code zu verstehen und die Dokumentation auf dem neuesten Stand zu halten, indem es README-Dateien für Ihren Code generiert.
Amazon Q kann neue Dokumentation erstellen und bestehende Dokumentation in Ihrer Codebasis aktualisieren. Durch die Analyse Ihres Projekts, Ihrer Codeobjekte und Abhängigkeiten innerhalb Ihrer Codebasis kann Amazon Q komplexe Codierungskonzepte dokumentieren und die Dokumentation auf der Grundlage neuer Codeänderungen aktualisieren.
Zum Generieren von Dokumenten öffnen Sie ein Projekt oder einen Workspace in Ihrer IDE und geben /doc in den Chat ein. Nachdem Sie die Art der Dokumentationsaktualisierung ausgewählt haben, an der Sie arbeiten möchten, analysiert Amazon Q Ihren Code, generiert Dokumentation und stellt eine Diff-Ansicht mit den vorgenommenen Änderungen bereit. Sie können die vorgeschlagenen Änderungen akzeptieren oder Feedback mit weiteren Änderungen geben, die Amazon Q vornehmen soll.
Informationen zu den unterstützten IDEs für diese Funktion finden Sie unter Unterstützte IDEs. Informationen zu den unterstützten Sprachen finden Sie unter Unterstützte Sprachen für Amazon Q Developer in der IDE.
Themen
Anwendungsfälle
Amazon Q kann die folgenden Aufgaben vom Chat-Bereich in der IDE aus erledigen.
-
Neue Dokumentation erstellen – Amazon Q kann basierend auf dem Code im ausgewählten Ordner neue README-Dateien für Ihr Projekt erstellen. Wenn Sie bereits eine README-Datei vorliegen haben und eine neue README-Datei erstellen möchten, überschreibt Amazon Q Ihre bestehende README-Datei und aktualisiert sie nicht. Sie haben immer noch die Möglichkeit, den neuen Inhalt zu überprüfen, bevor Amazon Q Ihre ursprüngliche README-Datei überschreibt.
-
Diagramme erstellen – Wenn Ihr Projektordner Infrastructure-as-Code-Dateien enthält (z. B. AWS CDK-Dateien, AWS CloudFormation-Vorlagen, Terraform-Konfigurationsdateien), erstellt Amazon Q Infrastrukturdiagramme, die in
infra.svg-Dateien im Ordnerdocsausgegeben und in der README-Datei referenziert werden. Wenn Sie Visual Studio Code verwenden, müssen Sie möglicherweise die Erweiterung SVG Preview (oder ähnlich) installieren, um die Diagramme in Ihrer IDE anzeigen zu können. -
Bestimmte Aktualisierungen vornehmen – Sie können die Änderungen, die Amazon Q an Ihrer README-Datei vornehmen soll, in natürlicher Sprache beschreiben. Dazu können Sie eine bestehende README-Datei aktualisieren und dann die Option zum Vornehmen einer bestimmten Änderung auswählen. Nachdem Amazon Q die Dokumentation generiert hat, haben Sie die Möglichkeit, weitere Änderungen zu beschreiben, die Sie vornehmen möchten. Sie können Aktualisierungen wie das Hinzufügen eines Abschnitts, das Entfernen oder Erläutern eines vorhandenen Abschnitts anfordern.
-
Neuen Code überprüfen und Aktualisierungen der Dokumentation vorschlagen – Nachdem Sie Codeänderungen vorgenommen haben, kann Amazon Q den neuen Code überprüfen und entsprechende Aktualisierungen für Ihre README-Datei vorschlagen.
Unterstützte Dateitypen
Amazon Q überprüft bei der Generierung der Dokumentation Ihre Quellcode- und Konfigurationsdateien, einschließlich, aber nicht beschränkt auf die folgenden Dateitypen:
-
.template
-
requirements.txt
-
package.json
-
tsconfig.json
-
Dockerfile
-
.git/config
-
LICENSE
-
LICENSE.md
-
CONTRIBUTING
-
CONTRIBUTING.md
Amazon Q filtert Dateien oder Ordner heraus, die in einer .gitignore-Datei definiert sind. Wenn Sie Dateien oder Ordner von der Überprüfung im Hinblick auf die Dokumentationserstellung ausschließen möchten, können Sie sie in eine .gitignore-Datei in Ihrem Projekt oder Workspace aufnehmen.
Kontingente
Bei der Dokumentationserstellung mit Amazon Q gelten die folgenden Kontingente:
-
README-Größe – Die maximale Größe einer README-Datei, die Amazon Q überprüfen oder generieren kann. Wenn eine vorhandene README-Datei dieses Kontingent überschreitet, kann Amazon Q die bestehende Dokumentation nicht aktualisieren. Überschreitet eine generierte README-Datei dieses Kontingent, kann Amazon Q die aktualisierte README-Datei nicht zurückgeben.
-
Größe des Codeprojekts – Die maximale Größe des Projekts oder Workspace, den Amazon Q zur Generierung von Dokumentation verwenden kann.
Auch wenn Sie einen kleineren Ordner auswählen, für den die Dokumentation generiert werden soll, muss das übergeordnete Projekt oder der übergeordnete Workspace innerhalb dieses Kontingents liegen.
-
Dokumenterstellungen pro Aufgabe – Gibt an, wie oft Sie Feedback geben können, um Änderungen an der generierten Dokumentation vorzunehmen, einschließlich der ersten Dokumenterstellung. Dieses Kontingent wird jedes Mal zurückgesetzt, wenn Sie eine neue Dokumentationsaufgabe starten.
| Ressource | Kontingent |
|---|---|
| README-Größe | 30 KB |
| Größe des Codeprojekts | 200 MB unkomprimiert 50 MB komprimiert |
| Dokumenterstellungen pro Aufgabe | 10 |
