Le traduzioni sono generate tramite traduzione automatica. In caso di conflitto tra il contenuto di una traduzione e la versione originale in Inglese, quest'ultima prevarrà.
Prima di iniziare, assicurati di aver installato Amazon Q in un IDE che supporti la generazione di documentazione. Per ulteriori informazioni, consulta Installazione dell'estensione o del plug-in Amazon Q Developer nel tuo IDE.
Per generare o aggiornare READMEs con Amazon Q nell'IDE, completa la seguente procedura:
-
Apri il tuo IDE su cui è installata l'estensione Amazon Q.
-
Scegli l'icona Amazon Q per aprire il pannello della chat. Specificare
/doc. -
Si apre una nuova scheda di chat. Amazon Q ti chiede di creare un nuovo README per il tuo codice o di aggiornare un README esistente.
-
Scegli il tipo di attività di documentazione su cui vuoi lavorare.
Se aggiorni un README esistente, scegli se desideri che Amazon Q aggiorni il tuo README con le recenti modifiche al codice o se desideri fornire modifiche specifiche che Amazon Q dovrebbe apportare al tuo README.
-
Amazon Q ti chiede di confermare che desideri generare la documentazione per la cartella attualmente aperta nel tuo IDE oppure puoi scegliere una nuova cartella.
Se hai scelto di apportare modifiche specifiche al tuo README, descrivi in dettaglio quali aggiornamenti desideri che Amazon Q apporti. Per idee su cosa includere nella descrizione, consultaBest practice.
Amazon Q inizia a generare la tua documentazione. Se la cartella del progetto contiene infrastructure-as-code file, Amazon Q creerà diagrammi di infrastruttura che verranno esportati in
infra.svgfile nelladocscartella e referenziati nel README. -
Dopo che Amazon Q ha generato i tuoi documenti, fornisce una differenza con eventuali modifiche. Puoi rivedere le differenze, quindi scegliere Accetta nella chat per aggiornare il tuo file README.
Se desideri apportare modifiche alla documentazione generata, scegli Apporta modifiche. Puoi quindi descrivere cosa vuoi che Amazon Q modifichi e genererà un README aggiornato.
