Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
fc708e5
Revise README for clarity and structure, consolidating course informa…
snehangshu-splunk Oct 8, 2025
16cdabb
Update README with specific repository URL for cloning to improve cla…
snehangshu-splunk Oct 8, 2025
efbd19e
Enhance README and module 1 documentation with clearer learning objec…
snehangshu-splunk Oct 8, 2025
2fec86b
Revise README to enhance clarity on the learning workflow and module …
snehangshu-splunk Oct 8, 2025
360aebf
Refactor README to streamline the learning workflow with clear, struc…
snehangshu-splunk Oct 8, 2025
391204f
Revise README to reorganize the learning path, consolidating sections…
snehangshu-splunk Oct 8, 2025
ca1bcfd
Remove the README file from the tutorials directory and enhance the m…
snehangshu-splunk Oct 8, 2025
6faa0a5
Refactor module 1 notebook to improve clarity and organization by rem…
snehangshu-splunk Oct 8, 2025
e9cb8c3
Update module 1 notebook to enhance documentation formatting by adjus…
snehangshu-splunk Oct 8, 2025
f642864
Refactor course structure by removing outdated tutorial modules and c…
snehangshu-splunk Oct 8, 2025
06e10dd
Update prompt writing objective in README
snehangshu-splunk Oct 9, 2025
170e18b
Update README to clarify learning objectives
snehangshu-splunk Oct 9, 2025
9a51e79
Develop Module 2 and the related resources (#2)
snehangshu-splunk Oct 10, 2025
c1eed31
Enhance README and module notebooks for clarity and user engagement
snehangshu-splunk Oct 13, 2025
cc58d38
Update 01-course/module-01-foundations/README.md
snehangshu-splunk Oct 13, 2025
f8810c2
Enhance module notebooks for clarity and consistency
snehangshu-splunk Oct 13, 2025
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 40 additions & 0 deletions 01-course/module-01-foundations/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
# Module 1: Foundations

## Course Introduction & Environment Setup

This foundational module introduces you to prompt engineering concepts and gets your development environment configured for hands-on learning.

### Learning Objectives
By completing this module, you will be able to:
- ✅ Set up a working development environment with AI assistant access
- ✅ Identify and apply the four core elements of effective prompts
- ✅ Write basic prompts for reviewing code
- ✅ Iterate and refine prompts based on output quality

### Getting Started

**First time here?**
- If you haven't set up your development environment yet, follow the [Quick Setup guide](../../README.md#-quick-setup) in the main README first
- **New to Jupyter notebooks?** Read [About Jupyter Notebooks](../../README.md#-about-jupyter-notebooks) to understand how notebooks work and where code executes

**Ready to start?**
1. **Open the tutorial notebook**: Click on [module1.ipynb](./module1.ipynb) to start the interactive tutorial
2. **Install dependencies**: Run the "Install Required Dependencies" cell in the notebook
3. **Follow the notebook**: Work through each cell sequentially - the notebook will guide you through setup and exercises
4. **Complete exercises**: Practice the hands-on activities as you go

### Module Contents
- **[module1.ipynb](./module1.ipynb)** - Complete module 1 tutorial notebook

### Time Required
Approximately 20 minutes

### Prerequisites
- Python 3.8+ installed
- IDE with notebook support (VS Code or Cursor recommended)
- API access to GitHub Copilot, CircuIT, or OpenAI

### Next Steps
After completing this module:
1. Review and refine your solutions to the exercises in this module
2. Continue to [Module 2: Core Prompting Techniques](../module-02-fundamentals/)
991 changes: 991 additions & 0 deletions 01-course/module-01-foundations/module1.ipynb

Large diffs are not rendered by default.

53 changes: 53 additions & 0 deletions 01-course/module-02-fundamentals/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
# Module 2: Fundamentals

## Core Prompt Engineering Techniques

This module covers the essential prompt engineering techniques that form the foundation of effective AI assistant interaction for software development.

### Learning Objectives
By completing this module, you will be able to:

- ✅ Apply eight core prompt engineering techniques to real coding scenarios
- ✅ Write clear instructions with specific constraints and requirements
- ✅ Use role prompting to transform AI into specialized domain experts
- ✅ Organize complex inputs using XML delimiters and structured formatting
- ✅ Teach AI your preferred styles using few-shot examples
- ✅ Implement chain-of-thought reasoning for systematic problem-solving
- ✅ Ground AI responses in reference texts with proper citations
- ✅ Break complex tasks into sequential workflows using prompt chaining
- ✅ Create evaluation rubrics and self-critique loops with LLM-as-Judge
- ✅ Separate reasoning from clean final outputs using inner monologue

### Getting Started

**First time here?** If you haven't set up your development environment yet, follow the [Quick Setup guide](../../README.md#-quick-setup) in the main README first.

**Ready to start?**
1. **Open the tutorial notebook**: Click on [module2.ipynb](./module2.ipynb) to start the interactive tutorial
2. **Install dependencies**: Run the "Install Required Dependencies" cell in the notebook
3. **Follow the notebook**: Work through each cell sequentially - the notebook will guide you through setup and exercises
4. **Complete exercises**: Practice the hands-on activities as you go

### Module Contents
- **[module2.ipynb](./module2.ipynb)** - Complete module 2 tutorial notebook

### Time Required
Approximately 90-120 minutes (1.5-2 hours)

**Time Breakdown:**
- Setup and introduction: ~10 minutes
- 8 core tactics with examples: ~70 minutes
- Hands-on practice activities: ~20-30 minutes
- Progress tracking: ~5 minutes

💡 **Tip:** You can complete this module in one session or break it into multiple shorter sessions. Each tactic is self-contained, making it easy to pause and resume.

### Prerequisites
- Python 3.8+ installed
- IDE with notebook support (VS Code or Cursor recommended)
- API access to GitHub Copilot, CircuIT, or OpenAI

### Next Steps
After completing this module:
1. Review and refine your solutions to the exercises in this module
2. Continue to [Module 3: Application in Software Engineering](../module-03-applications/)
Loading