AWS amazonq medium security documentation change
Summary
Restructured documentation to emphasize chat commands, agentic coding, and specific capabilities like code reviews/transforms. Added details about security vulnerability detection in code reviews section.
Security assessment
Added explicit documentation about Amazon Q's code review capability to detect security vulnerabilities in codebases. The new section states: 'Amazon Q can review your codebase for security vulnerabilities and code quality issues' with a dedicated link to code reviews documentation. This directly documents a security-focused feature.
Diff
diff --git a/amazonq/latest/qdeveloper-ug/q-in-IDE-chat.md b/amazonq/latest/qdeveloper-ug/q-in-IDE-chat.md index c98fabb7d..9b996966a 100644 --- a//amazonq/latest/qdeveloper-ug/q-in-IDE-chat.md +++ b//amazonq/latest/qdeveloper-ug/q-in-IDE-chat.md @@ -5 +5 @@ -Agentic codingUsing other natural languagesWorking with Amazon Q in your IDEExample topics and questionsReporting issues with responses +Working with Amazon Q in your IDEExample tasksExample questionsReporting issues with responses @@ -13,4 +12,0 @@ Chat with Amazon Q Developer in your integrated development environment (IDE) to - * The agentic coding experience with Amazon Q Developer in all supported IDEs - - * Chatting with Amazon Q in natural languages - @@ -19 +15,3 @@ Chat with Amazon Q Developer in your integrated development environment (IDE) to - * Example topics and questions + * Example tasks + + * Example questions @@ -22,0 +21,4 @@ Chat with Amazon Q Developer in your integrated development environment (IDE) to + * [Reviewing code with Amazon Q Developer](./code-reviews.html) + + * [Transforming code in the IDE with Amazon Q Developer ](./transform-in-IDE.html) + @@ -40 +42 @@ Chat with Amazon Q Developer in your integrated development environment (IDE) to -## The agentic coding experience with Amazon Q Developer in all supported IDEs +## Working with Amazon Q in your IDE @@ -42 +44 @@ Chat with Amazon Q Developer in your integrated development environment (IDE) to -Agentic coding is on by default for Amazon Q Developer in the IDE. +### Using chat @@ -44 +46 @@ Agentic coding is on by default for Amazon Q Developer in the IDE. -With agentic coding, Amazon Q acts as your coding partner, chatting agentically with you as you develop. +To start chatting with Amazon Q, choose the Amazon Q icon from the navigation bar in your IDE and enter your question in the text bar. To start chatting with Amazon Q in Visual Studio, choose **View** from the main menu and then choose **Amazon Q chat**. @@ -46 +48,9 @@ With agentic coding, Amazon Q acts as your coding partner, chatting agentically -As you discuss your project with Amazon Q, it will offer suggestions for shell commands. Sometimes, when it deems those commands to be low-risk, it will run them on its own. +When you ask Amazon Q a question, it uses the current file that is open in your IDE as context, including the programming language and the file path. You can add more context in your prompt or specify files, folders, or your whole workspace as context throughout a chat session. For more information, see [Adding context to the chat](./ide-chat-context.html). + +If Amazon Q includes code in its response, you can copy the code or insert it directly into your file by choosing **Insert at cursor**. Amazon Q might include inline references to its sources in its response. + +Amazon Q maintains the context of your conversation within a given session inform future responses. You can ask follow up questions or refer to previous questions and responses throughout the duration of your session. To start a new conversation with Amazon Q, open a new tab in the panel. You can open up to 10 tabs at a time. Amazon Q doesn't retain context across different conversations. + +#### Chat commands + +The following commands help you manage your chats with Amazon Q. @@ -48 +58 @@ As you discuss your project with Amazon Q, it will offer suggestions for shell c -When you ask Amazon Q to improve your code, it will do so directly. You can view the changes in a diff and optionally undo them. + * **/clear** \- Use this command to clear a current conversation. This removes all previous conversation from the chat panel and clears the context that Amazon Q has about your previous conversation. @@ -50 +60 @@ When you ask Amazon Q to improve your code, it will do so directly. You can view -While Amazon Q is thinking between prompts, you have the option to continue to add instructions in the input window. + * **/compact** \- Use this command to compact your chat history when the context window approaches its capacity limit. This creates a concise summary of your conversation while preserving essential information. @@ -52 +62 @@ While Amazon Q is thinking between prompts, you have the option to continue to a -You can toggle agentic coding on or off with the `</>` icon at the bottom of the chat panel. + * **/help** \- Use this command to see an overview of what Amazon Q can and can't do, example questions, and available features. @@ -54 +64,14 @@ You can toggle agentic coding on or off with the `</>` icon at the bottom of the -## Chatting with Amazon Q in natural languages + + + +### Agentic coding + +With agentic coding, Amazon Q acts as your coding partner, chatting with you as you develop. Agentic coding is on by default in the IDE. You can toggle agentic coding on or off with the `</>` icon at the bottom of the chat panel. + +When you ask Amazon Q to improve your code, it updates your files directly. You can view the changes in a diff and have the option to undo them. + +While Amazon Q is thinking or working on a task, you can continue to add instructions in the chat panel, and it will incorporate them into its work. + +As you discuss your project with Amazon Q, it will offer suggestions for shell commands. Sometimes, when it deems those commands to be low-risk, it will run them on its own. + +### Chatting in natural languages @@ -58 +81 @@ Amazon Q Developer provides multi-language support when you chat in the IDE. Sup -## Working with Amazon Q in your IDE +## Example tasks @@ -60 +83 @@ Amazon Q Developer provides multi-language support when you chat in the IDE. Sup -You can ask Amazon Q questions, update your code, and initiate actions with quick commands all from the Amazon Q chat panel in your IDE. +### Developing code features @@ -62 +85 @@ You can ask Amazon Q questions, update your code, and initiate actions with quic -To start chatting with Amazon Q, choose the Amazon Q icon from the navigation bar in your IDE and enter your question in the text bar. To start chatting with Amazon Q in Visual Studio, choose **View** from the main menu and then choose **Amazon Q chat**. +###### Note @@ -64 +87 @@ To start chatting with Amazon Q, choose the Amazon Q icon from the navigation ba -When you ask Amazon Q a question, it uses the current file that is open in your IDE as context, including the programming language and the file path. +This capability used to be referred to as /dev in this documentation and in the IDE. @@ -66 +89 @@ When you ask Amazon Q a question, it uses the current file that is open in your -If Amazon Q includes code in its response, you can copy the code or insert it directly into your file by choosing **Insert at cursor**. Amazon Q might include inline references to its sources in its response. To view a list of sources, expand the **Sources** section at the bottom of a response. +Amazon Q can help you develop code features, make code changes to projects, and answer questions about software development tasks in your integrated development environment (IDE). You explain the task you want to accomplish, and Amazon Q uses the context of your current project or workspace to generate code that you can apply to your codebase. Amazon Q can help you build AWS projects or your own applications. @@ -68 +91 @@ If Amazon Q includes code in its response, you can copy the code or insert it di -Amazon Q maintains the context of your conversation within a given session inform future responses. You can ask follow up questions or refer to previous questions and responses throughout the duration of your session. To start a new conversation with Amazon Q, open a new tab in the panel. You can open up to 10 tabs at a time. Amazon Q doesn't retain context across different conversations. +### Unit test generation @@ -70 +93 @@ Amazon Q maintains the context of your conversation within a given session infor -**Available features** +###### Note @@ -72 +95 @@ Amazon Q maintains the context of your conversation within a given session infor -You can access the following Amazon Q features through natural language requests in the chat panel, depending on your IDE. For information about what Amazon Q features are available in your IDE, see [Supported IDEs](./q-in-IDE.html#supported-ides-features). +This capability used to be referred to as /test in this documentation and in the IDE. @@ -74 +97 @@ You can access the following Amazon Q features through natural language requests - * **Code transformation** \- Ask Amazon Q to update the code language version of an entire project. For more information, see [Upgrading Java versions](./code-transformation.html). +Amazon Q can generate unit tests so you can automate testing throughout the software development lifecycle. This feature helps developers focus on accelerating feature development while ensuring code quality. @@ -76 +99 @@ You can access the following Amazon Q features through natural language requests - * **Feature development** \- Ask Amazon Q to get an implementation plan to develop a feature. For more information, see [Developing features](./software-dev.html). +### Documentation generation @@ -78 +101 @@ You can access the following Amazon Q features through natural language requests - * **Unit test generation** \- Ask Amazon Q to generate unit tests for your code. For more information, see [Generating unit tests](./test-generation.html). +###### Note @@ -80 +103 @@ You can access the following Amazon Q features through natural language requests - * **Code reviews** \- Ask Amazon Q to review your codebase for security vulnerabilities and code quality issues. For more information, see [Reviewing code](./code-reviews.html). +This capability used to be referred to as /doc in this documentation and in the IDE. @@ -82 +105 @@ You can access the following Amazon Q features through natural language requests - * **Documentation generation** \- Ask Amazon Q to generate READMEs for your project. For more information, see [Generating documentation](./doc-generation.html). +Amazon Q helps you understand your code and keep documentation up to date by generating READMEs and other documentation for your code. It can produce new documentation and update existing documentation in your codebase. @@ -84 +107 @@ You can access the following Amazon Q features through natural language requests - * **Clear conversation** \- Ask Amazon Q to clear the current conversation. This removes all previous conversation from the chat panel and clears the context that Amazon Q has about your previous conversation. +### Code reviews @@ -86 +109 @@ You can access the following Amazon Q features through natural language requests - * **Compact chat history** \- Ask Amazon Q to compact your chat history when the context window approaches its capacity limit. This creates a concise summary of your conversation while preserving essential information. +###### Note @@ -88 +111 @@ You can access the following Amazon Q features through natural language requests - * **Help** \- Ask Amazon Q for an overview of what it can and can't do, example questions, and available features. +This capability used to be referred to as /review in this documentation and in the IDE. @@ -89,0 +113 @@ You can access the following Amazon Q features through natural language requests +Amazon Q can review your codebase for security vulnerabilities and code quality issues to improve the posture of your applications throughout the development cycle. For more information on how to use this feature, see [Reviewing code with Amazon Q Developer](./code-reviews.html). @@ -90,0 +115 @@ You can access the following Amazon Q features through natural language requests +### Transforming code @@ -91,0 +117 @@ You can access the following Amazon Q features through natural language requests +Amazon Q can transform your code in integrated development environments (IDEs) by performing automated language and operating system (OS)-level upgrades and conversions. You provide the code to be transformed, and Amazon Q generates changes that you can review and apply to your files. For more information, see [Transforming code](./transform-in-IDE.html). @@ -93 +119 @@ You can access the following Amazon Q features through natural language requests -## Example topics and questions +## Example questions @@ -95 +121 @@ You can access the following Amazon Q features through natural language requests -Within IDEs, Amazon Q can answer questions about AWS services and software development, in addition to generating code. Amazon Q is particularly useful for answering questions related to the following subject areas: +Within IDEs, Amazon Q can answer questions about AWS services and software development, in addition to generating code. Amazon Q is particularly useful for answering questions related to the following subject areas. @@ -135 +161 @@ Installing Amazon Q -Explaining and updating code +Reviewing code