Skip to content

Commit 64361c1

Browse files
Clear execution count and outputs in module 1 notebook for a cleaner presentation, enhancing readability and organization. (#1)
* Revise README for clarity and structure, consolidating course information and enhancing navigation. Streamlined sections on tutorials, practice, and application, while updating prerequisites and setup instructions for improved user experience. * Update README with specific repository URL for cloning to improve clarity in setup instructions. * Enhance README and module 1 documentation with clearer learning objectives and structured workflow. Updated practice exercise descriptions and added self-assessment guidance to improve user experience and learning outcomes. * Revise README to enhance clarity on the learning workflow and module usage. Added structured steps for module engagement, emphasizing the importance of reading the README and completing interactive notebooks. Updated module descriptions to reflect their interactive nature and reinforced progress tracking and application of skills. * Refactor README to streamline the learning workflow with clear, structured steps for module engagement. Removed unnecessary HTML elements and improved formatting for better readability. Emphasized the importance of self-assessment and tracking progress throughout the learning process. * Revise README to reorganize the learning path, consolidating sections for interactive tutorials, practice, and application. Improved clarity and structure for better user navigation and engagement with the modules. * Remove the README file from the tutorials directory and enhance the module 1 notebook with a comprehensive introduction to prompt engineering, including structured learning objectives, prerequisites, and detailed explanations of the core elements of effective prompts. Updated the notebook to improve clarity, organization, and user engagement through hands-on activities and practical examples. * Refactor module 1 notebook to improve clarity and organization by removing unnecessary HTML elements and enhancing the presentation of solutions. Updated markdown sections for better readability and user engagement. * Update module 1 notebook to enhance documentation formatting by adjusting code block placement and improving clarity in user instructions. This change aims to provide a more structured presentation of the function documentation request. * Refactor course structure by removing outdated tutorial modules and consolidating content into a streamlined learning path. Updated README and module documentation to reflect new organization, enhancing clarity and user engagement. Removed unnecessary files and improved navigation for a better learning experience. * Update prompt writing objective in README * Update README to clarify learning objectives * Develop Module 2 and the related resources (#2) * Updated README files to provide structured content, including prerequisites and setup requirements, ensuring a better user experience for hands-on learning. Adjusted terminology for consistency and accuracy in prompt engineering techniques. * Update prompt writing objective in README * Update README to correct module reference from Module 2 to Module 3, ensuring accurate navigation for learners progressing through the course. * Update to refect correct timing and objectives. * Initial commit for Module 2 * Enhance module 1 notebook with improved instructions for GitHub Copilot API setup, including support for Claude models. Added guidance on handling long outputs and updated connection test feedback for clarity. Adjusted installation command to suppress output for a cleaner user experience. * Adjusted execution counts to null for consistency in cell execution tracking. * Enhance Module 2 notebook with improved GitHub Copilot API setup instructions, including support for Claude models. Updated installation command to suppress output for a cleaner user experience. Added detailed guidance on model options and connection testing, ensuring clarity for users. Adjusted print statements for consistent formatting across outputs. * Update print statements in Module 1 and Module 2 notebooks to enhance visual clarity. * Enhance README and module notebooks for clarity and user engagement - Updated README to replace "competency matrix" with "Skills Checklist" for consistency and improved tracking of progress. - Added a new section in the README about Jupyter notebooks, including important requirements and usage tips for beginners. - Enhanced Module 1 and Module 2 notebooks with detailed instructions on using break points and tracking progress, including interactive checkboxes for skill mastery. - Improved formatting and clarity in self-assessment sections and progress tracking templates across modules. * Update 01-course/module-01-foundations/README.md * Enhance module notebooks for clarity and consistency - Updated module 1 notebook to improve formatting and clarity in section headings, ensuring a more structured presentation of content. - Revised module 2 notebook to refine the goal description and enhance the clarity of instructions, including the removal of unnecessary elements and improved formatting. - Adjusted README for module 2 to change exercise instructions for better alignment with user expectations.
1 parent e4f3d0e commit 64361c1

File tree

19 files changed

+4367
-3622
lines changed

19 files changed

+4367
-3622
lines changed
Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
# Module 1: Foundations
2+
3+
## Course Introduction & Environment Setup
4+
5+
This foundational module introduces you to prompt engineering concepts and gets your development environment configured for hands-on learning.
6+
7+
### Learning Objectives
8+
By completing this module, you will be able to:
9+
- ✅ Set up a working development environment with AI assistant access
10+
- ✅ Identify and apply the four core elements of effective prompts
11+
- ✅ Write basic prompts for reviewing code
12+
- ✅ Iterate and refine prompts based on output quality
13+
14+
### Getting Started
15+
16+
**First time here?**
17+
- If you haven't set up your development environment yet, follow the [Quick Setup guide](../../README.md#-quick-setup) in the main README first
18+
- **New to Jupyter notebooks?** Read [About Jupyter Notebooks](../../README.md#-about-jupyter-notebooks) to understand how notebooks work and where code executes
19+
20+
**Ready to start?**
21+
1. **Open the tutorial notebook**: Click on [module1.ipynb](./module1.ipynb) to start the interactive tutorial
22+
2. **Install dependencies**: Run the "Install Required Dependencies" cell in the notebook
23+
3. **Follow the notebook**: Work through each cell sequentially - the notebook will guide you through setup and exercises
24+
4. **Complete exercises**: Practice the hands-on activities as you go
25+
26+
### Module Contents
27+
- **[module1.ipynb](./module1.ipynb)** - Complete module 1 tutorial notebook
28+
29+
### Time Required
30+
Approximately 20 minutes
31+
32+
### Prerequisites
33+
- Python 3.8+ installed
34+
- IDE with notebook support (VS Code or Cursor recommended)
35+
- API access to GitHub Copilot, CircuIT, or OpenAI
36+
37+
### Next Steps
38+
After completing this module:
39+
1. Review and refine your solutions to the exercises in this module
40+
2. Continue to [Module 2: Core Prompting Techniques](../module-02-fundamentals/)

01-course/module-01-foundations/module1.ipynb

Lines changed: 991 additions & 0 deletions
Large diffs are not rendered by default.
Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
# Module 2: Fundamentals
2+
3+
## Core Prompt Engineering Techniques
4+
5+
This module covers the essential prompt engineering techniques that form the foundation of effective AI assistant interaction for software development.
6+
7+
### Learning Objectives
8+
By completing this module, you will be able to:
9+
10+
- ✅ Apply eight core prompt engineering techniques to real coding scenarios
11+
- ✅ Write clear instructions with specific constraints and requirements
12+
- ✅ Use role prompting to transform AI into specialized domain experts
13+
- ✅ Organize complex inputs using XML delimiters and structured formatting
14+
- ✅ Teach AI your preferred styles using few-shot examples
15+
- ✅ Implement chain-of-thought reasoning for systematic problem-solving
16+
- ✅ Ground AI responses in reference texts with proper citations
17+
- ✅ Break complex tasks into sequential workflows using prompt chaining
18+
- ✅ Create evaluation rubrics and self-critique loops with LLM-as-Judge
19+
- ✅ Separate reasoning from clean final outputs using inner monologue
20+
21+
### Getting Started
22+
23+
**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.
24+
25+
**Ready to start?**
26+
1. **Open the tutorial notebook**: Click on [module2.ipynb](./module2.ipynb) to start the interactive tutorial
27+
2. **Install dependencies**: Run the "Install Required Dependencies" cell in the notebook
28+
3. **Follow the notebook**: Work through each cell sequentially - the notebook will guide you through setup and exercises
29+
4. **Complete exercises**: Practice the hands-on activities as you go
30+
31+
### Module Contents
32+
- **[module2.ipynb](./module2.ipynb)** - Complete module 2 tutorial notebook
33+
34+
### Time Required
35+
Approximately 90-120 minutes (1.5-2 hours)
36+
37+
**Time Breakdown:**
38+
- Setup and introduction: ~10 minutes
39+
- 8 core tactics with examples: ~70 minutes
40+
- Hands-on practice activities: ~20-30 minutes
41+
- Progress tracking: ~5 minutes
42+
43+
💡 **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.
44+
45+
### Prerequisites
46+
- Python 3.8+ installed
47+
- IDE with notebook support (VS Code or Cursor recommended)
48+
- API access to GitHub Copilot, CircuIT, or OpenAI
49+
50+
### Next Steps
51+
After completing this module:
52+
1. Review and refine your solutions to the exercises in this module
53+
2. Continue to [Module 3: Application in Software Engineering](../module-03-applications/)

0 commit comments

Comments
 (0)