Generating and updating READMEs with Amazon Q Developer - Amazon Q Developer

Generating and updating READMEs with Amazon Q Developer

Before you get started, make sure you've installed Amazon Q in an IDE that supports documentation generation. For more information, see Installing the Amazon Q Developer extension or plugin in your IDE.

To generate or update READMEs with Amazon Q in the IDE, complete the following procedure:

  1. Open your IDE where you have the Amazon Q extension installed.

  2. Choose the Amazon Q icon to open the chat panel. Enter /doc.

  3. A new chat tab opens. Amazon Q prompts you to create a new README for your code or to update existing an README.

  4. Choose which type of documentation task you want to work on.

    If you update an existing README, choose whether you want Amazon Q to update your README with recent code changes, or if you want to provide specific changes Amazon Q should make to your README.

  5. Amazon Q prompts you to confirm that you want to generate documentation for the current open folder in your IDE, or you can choose a new folder.

    If you chose to make specific changes to your README, describe in detail what updates you want Amazon Q to make. For ideas on what to include in your description, see Best practices.

    Amazon Q begins generating your documentation.

  6. After Amazon Q has generated your documents, it provides a diff with any changes. You can review the diffs, and then choose Accept in the chat to update your README in place.

    If you want to make changes to the documentation generated, choose Make changes. You can then describe what you’d like Amazon Q to change and it will generate an updated README.