Amazon Q Learning Files

This document explains the standardized naming convention for Amazon Q learning files across different projects and directories.

Naming Convention

All Amazon Q learning files follow this naming pattern:

q-learning-{context}.md

Where {context} is a descriptor of the project or area (e.g., “datalake”, “streaming”, “general”).

File Locations

Purpose

These files serve as a knowledge base for Amazon Q to:

1. Better understand your work style and preferences
2. Improve collaboration and assistance
3. Provide more relevant and contextual help
4. Optimize Q CLI token usage by maintaining context

Usage

When working with Amazon Q in a specific project context, it will automatically reference the relevant learning file to provide more tailored assistance.

You can update these files manually or ask Amazon Q to update them with new insights from your interactions.

Format

All files use Markdown (.md) format for:

• Better structure and readability
• Support for rich formatting (headers, lists, code blocks)
• Compatibility with version control systems
• Easy viewing in most text editors and documentation tools

Updating Guidelines

When updating q-learning files:

• PRESERVE the existing structure and content
• ADD new learnings to the appropriate sections rather than reformatting the entire document
• MAINTAIN the established organization and formatting
• EXTEND existing sections with new insights rather than replacing them
• RESPECT the document’s original structure and flow