Generieren und Aktualisieren von README-Dateien mit Amazon Q Developer - Amazon Q Developer

Generieren und Aktualisieren von README-Dateien 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.

Bevor Sie beginnen, vergewissern Sie sicher, dass Sie Amazon Q in einer IDE installiert haben, die die Generierung von Dokumentation unterstützt. Weitere Informationen finden Sie unter Installieren der Erweiterung oder des Plugins von Amazon Q Developer in Ihrer IDE.

Gehen Sie wie folgt vor, um README-Dateien mit Amazon Q in der IDE zu generieren oder zu aktualisieren:

  1. Öffnen Sie Ihre IDE, in der Sie die Amazon-Q-Erweiterung installiert haben.

  2. Wählen Sie das Amazon-Q-Symbol aus, um den Chat-Bereich zu öffnen. Geben Sie /doc ein.

  3. Eine neue Chat-Registerkarte wird geöffnet. Amazon Q fordert Sie auf, eine neue README-Datei für Ihren Code zu erstellen oder eine bestehende README-Datei zu aktualisieren.

  4. Wählen Sie aus, an welcher Art von Dokumentationsaufgabe Sie arbeiten möchten.

    Bei der Aktualisierung einer bestehenden README-Datei wählen Sie aus, ob Amazon Q Ihre README-Datei mit aktuellen Codeänderungen aktualisieren soll, oder ob Sie bestimmte Änderungen angeben möchten, die Amazon Q an Ihrer README-Datei vornehmen soll.

  5. Amazon Q fordert Sie auf zu bestätigen, dass Sie Dokumentation für den aktuell geöffneten Ordner in Ihrer IDE generieren möchten. Sie können aber auch einen neuen Ordner auswählen.

    Wenn Sie bestimmte Änderungen an Ihrer README-Datei vornehmen möchten, beschreiben Sie detailliert, welche Aktualisierungen Amazon Q vornehmen soll. Anregungen dazu, was Sie in Ihre Beschreibung aufnehmen sollten, finden Sie unter Bewährte Methoden.

    Amazon Q beginnt mit der Erstellung Ihrer Dokumentation. Wenn Ihr Projektordner Infrastructure-as-Code-Dateien enthält, erstellt Amazon Q Infrastrukturdiagramme, die in infra.svg-Dateien im docs-Ordner ausgegeben und in der README-Datei referenziert werden.

  6. Nachdem Amazon Q Ihre Dokumente generiert hat, bietet es eine Diff-Ansicht mit allen Änderungen. Sie können die Unterschiede überprüfen und dann im Chat auf Accept klicken, um Ihre README-Datei zu aktualisieren.

    Wenn Sie Änderungen an der generierten Dokumentation vornehmen möchten, wählen Sie Make changes aus. Sie können dann beschreiben, was Amazon Q ändern soll. Daraufhin wird eine aktualisierte README-Datei generiert.