Help improve this page
To contribute to this user guide, choose the Edit this page on GitHub link that is located in the right pane of every page.
You can use Amazon Q to create and revise docs content. This is an easy way to get started on a new page. Amazon Q is available as an extension to Visual Studio (VS) Code.
In the following image, Amazon Q generated the lines marked with green.
Install Amazon Q with VS Code
-
Open VS Code
-
Go to the Extensions view (Ctrl+Shift+X or Cmd+Shift+X)
-
Search for "Amazon Q"
-
Click Install on the Amazon Q extension
-
Wait for installation to complete
-
Restart VS Code when prompted
Login to Amazon Q
-
After installing, choose the Amazon Q icon in the VS Code activity bar.
-
Choose Sign in to Amazon Q.
-
Enter your AWS credentials when prompted.
-
Once authenticated, you’ll see the Amazon Q chat interface.
Use Amazon Q to create content
-
Open the file you want to edit in VS Code.
-
Select the text you want to revise or the location for new content.
-
Press Ctrl+I or Cmd+I.
-
In the prompt, be specific about:
-
The type of content you need.
-
The target audience.
-
Key points to cover.
-
Desired tone and style.
-
-
Review the generated content in the inline preview.
-
Use enter to accept the changes, or esc to reject them.
-
Edit further as needed.
Tips
-
Start with a simple request and iterate to get the content you want.
-
Create a first draft of the page headings, then ask Q to fill them in.
-
Amazon Q might output Markdown. This is fine. The AsciiDoc tooling can understand most markdown syntax.
To learn more about Amazon Q Developer, see Using Amazon Q Developer in the IDE.
