使用 Amazon Q Developer 產生和更新 README - Amazon Q Developer

使用 Amazon Q Developer 產生和更新 README

注意

您可以要求直接在聊天中產生文件。如果您使用 /doc，您的請求將重新導向至聊天。嘗試提問 generate documentation for my application。

開始進行之前，請確定您已在支援產生文件的 IDE 中安裝 Amazon Q。如需詳細資訊，請參閱 在 IDE 中安裝 Amazon Q Developer 延伸模組或外掛程式。

若要在 IDE 中使用 Amazon Q 產生或更新 README，請完成下列程序：

  1. 開啟已安裝 Amazon Q 延伸模組的 IDE。

  2. 選擇 Amazon Q 圖示以開啟聊天面板。輸入 /doc。

  3. 新的聊天索引標籤隨即開啟。Amazon Q 會提示您為程式碼建立新的 README，或更新現有的 README。

  4. 選擇您要處理的文件任務類型。

    如果您更新現有的 README，請選擇要讓 Amazon Q 使用最近的程式碼變更來更新 README，或是要提供 Amazon Q 應對 README 進行的特定變更。

  5. Amazon Q 會提示您確認要針對 IDE 中目前開啟的資料夾產生文件，您也可以選擇新的資料夾。

    如果您選擇對 README 進行特定變更，請詳述您希望 Amazon Q 進行哪些更新。如需描述中要包含哪些內容的想法，請參閱 最佳實務。

    Amazon Q 會開始產生您的文件。如果您的專案資料夾包含基礎結構即程式碼檔案，Amazon Q 會建立基礎結構圖表，此圖表會輸出至 docs 資料夾中的 infra.svg 檔案，並且在 README 中參考。

  6. Amazon Q 產生您的文件之後，會提供任何變更的差異。您可以檢閱差異，然後在聊天中選擇接受，以就地更新您的 README。

    如果您想要對產生的文件進行變更，請選擇進行變更。然後，您可以描述希望 Amazon Q 變更的內容，它將會產生更新的 README。