Skip to content

Commit b001783

Browse files
paulanunes85paulanunes85
committed
Add Workshop FAQ section and notes on AI variability in complete workshop guide
1 parent 5206911 commit b001783

File tree

3 files changed

+303
-0
lines changed

3 files changed

+303
-0
lines changed

‎docs/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ The documentation provides a complete learning framework for AI-assisted develop
2828
| [🏗️ Complete Workshop](complete_workshop_guide.md) | Comprehensive hands-on implementation | 90+ minutes | All levels |
2929
| [🆘 Troubleshooting](troubleshooting_guide.md) | Problem resolution and diagnostics | As needed | All participants |
3030
| [🏢 Workshop Structure](workshop_structure.md) | Instructor guide and facilitation | Variable | Instructors/Facilitators |
31+
| [🤔 Workshop FAQ](workshop-faq.md) | Comprehensive Q&A for all topics | As needed | All participants |
3132

3233
### 🎯 Learning Paths
3334

‎docs/complete_workshop_guide.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,8 @@
1818
- 🤖 **AI-First Approach:** GitHub Copilot as your development partner
1919
- 📈 **Measurable Outcomes:** 50-70% productivity improvement
2020

21+
> **🤔 Questions?** Check our comprehensive [Workshop FAQ](workshop-faq.md) covering everything from AI ethics to technical troubleshooting!
22+
2123
## 📁 Workshop Resources Overview
2224

2325
> **🔧 All automation scripts, code examples, and templates are available in the `/resources` directory**
@@ -805,6 +807,13 @@ pie title Developer Time Distribution
805807

806808
### 🚀 Hands-On Exercise 1: Your First AI-Generated Code (20 minutes)
807809

810+
> **👨‍🏫 Workshop Facilitator Note:**
811+
> - Participants WILL get different code suggestions - this is expected!
812+
> - Prepare to explain AI variability (it's a feature, not a bug)
813+
> - Emphasize that different implementations are learning opportunities
814+
> - Have the reference implementation ready to share if needed
815+
> - Encourage participants to share their variations with the group
816+
808817
### 🎯 1.1 Create Your First AI-Assisted Code
809818

810819
> ⏱️ **Time Required:** 10 minutes
@@ -973,6 +982,15 @@ To ensure everyone gets similar results:
973982

974983
> 💡 **Pro Tip:** If Copilot generates significantly different code, use it as a learning opportunity to understand different implementation approaches!
975984

985+
#### ❓ Common Questions About This Exercise
986+
987+
> **📚 Having questions about AI variability?** Check our comprehensive [Workshop FAQ](workshop-faq.md#workshop-exercise-questions) for answers to:
988+
> - Why your code differs from others
989+
> - Whether different implementations are correct
990+
> - How to evaluate AI-generated code quality
991+
> - When to modify vs. keep AI suggestions
992+
> - And many more common concerns!
993+
976994
#### 📚 Reference Implementation
977995

978996
If GitHub Copilot generates very different code, use this reference implementation:

‎docs/workshop-faq.md

Lines changed: 284 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,284 @@
1+
# 🤔 AI-Powered Development Workshop - Frequently Asked Questions
2+
3+
> **📋 Table of Contents**
4+
> - [General AI Development Questions](#general-ai-development-questions)
5+
> - [GitHub Copilot Specific Questions](#github-copilot-specific-questions)
6+
> - [Workshop Exercise Questions](#workshop-exercise-questions)
7+
> - [Technical Issues and Troubleshooting](#technical-issues-and-troubleshooting)
8+
> - [Ethical and Professional Concerns](#ethical-and-professional-concerns)
9+
> - [Enterprise and Security Questions](#enterprise-and-security-questions)
10+
> - [Learning Path and Career Questions](#learning-path-and-career-questions)
11+
12+
---
13+
14+
## 🤖 General AI Development Questions
15+
16+
### Q: "Is AI going to replace developers?"
17+
**A:** No! AI is a tool that amplifies developer capabilities, not replaces them. Think of it like:
18+
- 🔨 A power drill doesn't replace carpenters, it makes them more efficient
19+
- 🤖 AI handles repetitive tasks so you can focus on creative problem-solving
20+
- 🧠 You still need to understand the code, architecture, and business logic
21+
- ✅ AI suggestions need human review, context, and decision-making
22+
23+
### Q: "How accurate is AI-generated code?"
24+
**A:** AI accuracy varies significantly:
25+
- ✅ **High accuracy (80-90%)**: Common patterns, standard algorithms, boilerplate code
26+
- ⚠️ **Medium accuracy (50-70%)**: Business logic, complex algorithms, domain-specific code
27+
- ❌ **Low accuracy (20-40%)**: Cutting-edge tech, proprietary systems, highly specific requirements
28+
- 🔍 **Always review**: Never trust AI blindly - always review and test generated code
29+
30+
### Q: "Can I use AI-generated code in production?"
31+
**A:** Yes, but with important considerations:
32+
- ✅ Always review and understand the code before using it
33+
- ✅ Test thoroughly - AI doesn't guarantee bug-free code
34+
- ✅ Check licensing and compliance requirements
35+
- ✅ Ensure code meets your organization's standards
36+
- ⚠️ Be extra careful with security-sensitive code
37+
38+
---
39+
40+
## 💻 GitHub Copilot Specific Questions
41+
42+
### Q: "Why is my Copilot suggestion different from my colleague's?"
43+
**A:** GitHub Copilot's variability is due to several factors:
44+
45+
| Factor | Impact | Example |
46+
|--------|--------|---------|
47+
| **Context** | Different open files = different suggestions | Having a test file open might generate test-focused code |
48+
| **History** | Your recent edits influence suggestions | If you just wrote Java code, Copilot might favor Java patterns |
49+
| **Model Version** | Copilot updates regularly | Newer versions might suggest different patterns |
50+
| **Randomness** | AI has inherent non-determinism | Same prompt can yield variations |
51+
| **Settings** | IDE and Copilot configurations | Temperature settings affect creativity vs consistency |
52+
53+
### Q: "Copilot isn't giving me any suggestions. What's wrong?"
54+
**A:** Common troubleshooting steps:
55+
1. **Check connection**: Ensure you're connected to the internet
56+
2. **Verify authentication**: Look for Copilot icon in status bar
57+
3. **Check subscription**: Ensure your trial/subscription is active
58+
4. **File type**: Copilot works best with common programming languages
59+
5. **Restart VS Code**: Sometimes a simple restart helps
60+
6. **Check firewall**: Corporate firewalls might block Copilot
61+
62+
### Q: "Is Copilot learning from my code?"
63+
**A:** No, GitHub Copilot:
64+
- ❌ Does NOT train on your private code
65+
- ❌ Does NOT send your code to train the model
66+
- ✅ Uses pre-trained models from public code
67+
- ✅ Processes your code locally for context only
68+
- 🔒 Your code remains private and secure
69+
70+
### Q: "Can I use Copilot for any programming language?"
71+
**A:** Copilot supports many languages with varying effectiveness:
72+
- **🟢 Excellent**: JavaScript, Python, TypeScript, Java, C#, Go, Ruby
73+
- **🟡 Good**: C++, PHP, Swift, Kotlin, Rust, SQL
74+
- **🟠 Limited**: Haskell, Scala, R, MATLAB, Assembly
75+
- **🔴 Minimal**: Proprietary or rare languages
76+
77+
---
78+
79+
## 📝 Workshop Exercise Questions
80+
81+
### Q: "My Calculator code looks nothing like the example. Is it wrong?"
82+
**A:** Not necessarily! Check if your code:
83+
- ✅ Has all four operations (add, subtract, multiply, divide)
84+
- ✅ Handles division by zero
85+
- ✅ Compiles without errors
86+
- ✅ Produces correct results
87+
88+
If yes to all, your code is fine! Different implementations teach us different approaches.
89+
90+
### Q: "The string optimization exercise shows minimal improvement. Why?"
91+
**A:** Performance improvements depend on:
92+
- **Dataset size**: Small datasets (10 items) show minimal difference
93+
- **JVM/Runtime optimization**: Modern runtimes optimize simple cases
94+
- **Measurement precision**: Nanosecond measurements can be noisy
95+
- **Hardware**: Different machines show different results
96+
97+
Try with 10,000+ items to see dramatic differences!
98+
99+
### Q: "The SQL injection example seems unrealistic. Do developers really write code like that?"
100+
**A:** Unfortunately, yes:
101+
- 📊 **OWASP Top 10**: SQL injection remains a top vulnerability
102+
- 🏢 **Legacy code**: Many systems still have vulnerable code
103+
- 🚀 **Rushed development**: Time pressure leads to shortcuts
104+
- 📚 **Education gaps**: Not all developers learn secure coding
105+
106+
This exercise teaches you to recognize and fix these issues!
107+
108+
### Q: "Why do we need to validate input twice (client and server)?"
109+
**A:** Defense in depth principle:
110+
- 🖥️ **Client validation**: Better user experience, immediate feedback
111+
- 🔒 **Server validation**: Security (client validation can be bypassed)
112+
- 🛡️ **Never trust the client**: Attackers can modify client-side code
113+
- ✅ **Best practice**: Always validate on the server, optionally on client
114+
115+
---
116+
117+
## 🔧 Technical Issues and Troubleshooting
118+
119+
### Q: "My Azure resources creation failed. What should I do?"
120+
**A:** Common issues and solutions:
121+
122+
| Error | Cause | Solution |
123+
|-------|-------|----------|
124+
| **"Subscription not found"** | Wrong subscription selected | Run `az account set --subscription <name>` |
125+
| **"Name already exists"** | Resource name taken | Script adds timestamp, try again |
126+
| **"Quota exceeded"** | Subscription limits | Use a different region or contact Azure support |
127+
| **"Region not available"** | Service not in region | Script auto-selects compatible region |
128+
| **"Insufficient permissions"** | Not enough rights | Need Contributor role on subscription |
129+
130+
### Q: "The workshop files are in the wrong encoding/have strange characters"
131+
**A:** File encoding issues:
132+
- Ensure UTF-8 encoding in your editor
133+
- On Windows, check for BOM (Byte Order Mark)
134+
- Use `dos2unix` for line ending issues
135+
- Clone with `git config core.autocrlf false`
136+
137+
### Q: "My Java/C# environment isn't working correctly"
138+
**A:** Environment checklist:
139+
- ✅ Correct version installed (Java 17+, .NET 6+)
140+
- ✅ PATH environment variable set
141+
- ✅ JAVA_HOME (for Java) configured
142+
- ✅ IDE recognizes the SDK
143+
- ✅ Restart terminal/IDE after installation
144+
145+
---
146+
147+
## 🤔 Ethical and Professional Concerns
148+
149+
### Q: "Is it cheating to use AI for coding?"
150+
**A:** No, it's tool adoption:
151+
- 🛠️ Using AI is like using an IDE instead of notepad
152+
- 📚 You still need to understand the code
153+
- 🎓 Many universities and companies encourage AI tool usage
154+
- ✅ The key is understanding, not just copying
155+
- 🏢 Most modern companies expect AI tool proficiency
156+
157+
### Q: "What about code ownership and licensing?"
158+
**A:** Important considerations:
159+
- **Your code**: You own code you write with AI assistance
160+
- **AI suggestions**: Based on patterns from public code
161+
- **License compliance**: You're responsible for ensuring compliance
162+
- **Attribution**: Not required for AI assistance
163+
- **Company policy**: Check your organization's AI usage policy
164+
165+
### Q: "How do I know if AI-generated code is plagiarized?"
166+
**A:** AI doesn't copy-paste, but:
167+
- 🔍 AI learns patterns from public code
168+
- 📝 Common patterns might match existing code
169+
- ✅ Run code through plagiarism checkers if concerned
170+
- 🎯 Focus on understanding and adapting, not just using
171+
- 📚 Add your own comments and modifications
172+
173+
### Q: "Should I mention AI assistance in code reviews?"
174+
**A:** Best practices:
175+
- ✅ Be transparent with your team
176+
- 📝 Focus on code quality, not generation method
177+
- 🔍 Ensure you can explain every line
178+
- 🤝 Follow team/company guidelines
179+
- 💡 Share AI techniques that helped
180+
181+
---
182+
183+
## 🏢 Enterprise and Security Questions
184+
185+
### Q: "Is GitHub Copilot safe for enterprise use?"
186+
**A:** Enterprise considerations:
187+
188+
| Aspect | Details |
189+
|--------|---------|
190+
| **Data Privacy** | Code processed locally, not stored |
191+
| **Compliance** | SOC 2 Type 2 certified |
192+
| **Network** | Works behind corporate firewalls |
193+
| **Control** | Admins can manage access and settings |
194+
| **Audit** | Usage can be monitored and reported |
195+
196+
### Q: "What about sensitive code and secrets?"
197+
**A:** Security best practices:
198+
- ❌ Never put secrets in code (with or without AI)
199+
- ✅ Use environment variables or secret managers
200+
- ✅ Configure .gitignore properly
201+
- ✅ Review AI suggestions for accidental secrets
202+
- 🔒 Use tools like git-secrets for scanning
203+
204+
### Q: "Can we use the workshop's Azure resources for real projects?"
205+
**A:** No! Workshop resources are:
206+
- 🧪 For learning only
207+
- 💰 Not optimized for cost
208+
- 🔓 Using default passwords
209+
- ⚠️ Missing production security
210+
- 🗑️ Should be deleted after workshop
211+
212+
### Q: "How do we implement AI development at scale?"
213+
**A:** Enterprise adoption strategy:
214+
1. **Pilot**: Start with small team
215+
2. **Measure**: Track productivity metrics
216+
3. **Train**: Develop best practices
217+
4. **Expand**: Roll out gradually
218+
5. **Govern**: Establish policies and guidelines
219+
220+
---
221+
222+
## 📚 Learning Path and Career Questions
223+
224+
### Q: "What should I learn after this workshop?"
225+
**A:** Recommended learning path:
226+
227+
| Level | Focus | Resources |
228+
|-------|-------|-----------|
229+
| **Next Week** | Practice daily with Copilot | Use on real projects |
230+
| **Month 1** | Advanced Copilot features | Copilot Chat, workspace commands |
231+
| **Month 2** | Other AI tools | Cursor, Codeium, Amazon CodeWhisperer |
232+
| **Month 3** | AI integration | CI/CD with AI, automated testing |
233+
| **Ongoing** | Stay updated | Follow AI development news |
234+
235+
### Q: "Will AI development skills help my career?"
236+
**A:** Absolutely! Market demand:
237+
- 📈 **75% of developers** will use AI by 2028 (Gartner)
238+
- 💰 **Higher salaries** for AI-skilled developers
239+
- 🚀 **Faster career growth** with modern skills
240+
- 🏢 **Company requirement** at many organizations
241+
- 🌟 **Competitive advantage** in job market
242+
243+
### Q: "How do I convince my team/manager to adopt AI tools?"
244+
**A:** Building the business case:
245+
1. **Start small**: Personal productivity gains
246+
2. **Measure impact**: Track time saved
247+
3. **Share successes**: Demo to team
248+
4. **Address concerns**: Security, cost, accuracy
249+
5. **Propose pilot**: Limited trial with metrics
250+
251+
### Q: "What if my company doesn't allow AI tools?"
252+
**A:** Alternative approaches:
253+
- 🏠 Practice on personal projects
254+
- 📚 Learn concepts even without tools
255+
- 🗣️ Advocate for change with data
256+
- 🔍 Understand company concerns
257+
- 🚀 Be ready when policy changes
258+
259+
---
260+
261+
## 🆘 Still Have Questions?
262+
263+
### Workshop Support Channels
264+
265+
| Channel | Purpose | Response Time |
266+
|---------|---------|---------------|
267+
| **GitHub Issues** | Technical problems | 24-48 hours |
268+
| **Workshop Chat** | Live questions during workshop | Immediate |
269+
| **Email Support** | Detailed questions | 2-3 days |
270+
| **Community Forum** | Peer discussions | Community-driven |
271+
272+
### How to Ask Good Questions
273+
274+
1. **Be specific**: Include error messages, code snippets
275+
2. **Show effort**: Explain what you've tried
276+
3. **Provide context**: OS, versions, environment
277+
4. **One issue**: Focus on single problem
278+
5. **Be patient**: Everyone is learning!
279+
280+
---
281+
282+
> **📝 Note**: This FAQ is continuously updated based on workshop feedback. Last updated: January 2024
283+
284+
[⬅️ Back to Workshop Guide](complete_workshop_guide.md) | [🏠 Back to Main README](../README.md)

0 commit comments

Comments
 (0)