ai-playbook 1.0.0

package/skills/software-development/examples.md

@@ -0,0 +1,375 @@
+# Software Development Skill - Examples
+
+This document contains practical examples demonstrating when and how to use the Software Development Skill.
+
+---
+
+# Example 1 - Implement a New Feature
+
+## User Request
+
+```
+Implement a REST endpoint to export customer orders as CSV.
+```
+
+## Expected Behavior
+
+The AI should:
+
+* Understand the existing architecture.
+* Find similar endpoints.
+* Reuse existing CSV utilities.
+* Validate inputs.
+* Implement controller, service, and repository changes.
+* Add unit and integration tests.
+* Update API documentation.
+
+---
+
+# Example 2 - Bug Fix
+
+## User Request
+
+```
+Users can submit the same payment twice when clicking quickly.
+Fix the bug.
+```
+
+## Expected Behavior
+
+The AI should:
+
+* Identify the root cause.
+* Analyze race conditions.
+* Check existing transaction handling.
+* Implement idempotency.
+* Add regression tests.
+* Explain why the issue occurred.
+
+---
+
+# Example 3 - Refactoring
+
+## User Request
+
+```
+This service has grown to 1,200 lines.
+Refactor it.
+```
+
+## Expected Behavior
+
+The AI should:
+
+* Preserve functionality.
+* Extract reusable methods.
+* Separate business logic.
+* Reduce duplication.
+* Improve readability.
+* Keep commits small and safe.
+* Ensure existing tests continue to pass.
+
+---
+
+# Example 4 - API Development
+
+## User Request
+
+```
+Create a new Spring Boot API for managing products.
+```
+
+## Expected Behavior
+
+Generate:
+
+* Controller
+* Service
+* Repository
+* Entity
+* DTOs
+* Validation
+* Exception handling
+* Swagger/OpenAPI documentation
+* Unit tests
+* Integration tests
+
+---
+
+# Example 5 - Database Optimization
+
+## User Request
+
+```
+This API is taking 8 seconds.
+Optimize it.
+```
+
+## Expected Behavior
+
+The AI should investigate:
+
+* Slow SQL queries
+* Missing indexes
+* N+1 queries
+* Large joins
+* Full table scans
+* Repeated database calls
+* Inefficient pagination
+
+Recommend measurable improvements before making changes.
+
+---
+
+# Example 6 - Code Review
+
+## User Request
+
+```
+Review this pull request.
+```
+
+## Expected Behavior
+
+Review for:
+
+* Correctness
+* Readability
+* Maintainability
+* Security
+* Performance
+* Error handling
+* Testing
+* Logging
+* Naming conventions
+* Project standards
+
+Provide constructive feedback and suggested improvements.
+
+---
+
+# Example 7 - Unit Testing
+
+## User Request
+
+```
+Write unit tests for this service.
+```
+
+## Expected Behavior
+
+Generate tests covering:
+
+* Happy path
+* Validation
+* Exceptions
+* Edge cases
+* Boundary conditions
+* Mocked dependencies
+* High code coverage without testing implementation details
+
+---
+
+# Example 8 - Integration Testing
+
+## User Request
+
+```
+Write integration tests for this REST API.
+```
+
+## Expected Behavior
+
+Test:
+
+* Endpoints
+* Authentication
+* Authorization
+* Validation
+* Database persistence
+* Error responses
+* HTTP status codes
+* Serialization/deserialization
+
+---
+
+# Example 9 - Performance Improvement
+
+## User Request
+
+```
+Reduce memory usage in this application.
+```
+
+## Expected Behavior
+
+Investigate:
+
+* Large object allocations
+* Memory leaks
+* Excessive caching
+* Duplicate collections
+* Expensive loops
+* Object reuse opportunities
+* Streaming vs loading entire datasets
+
+Recommend changes backed by reasoning.
+
+---
+
+# Example 10 - Security Review
+
+## User Request
+
+```
+Review this authentication service.
+```
+
+## Expected Behavior
+
+Inspect for:
+
+* Authentication flaws
+* Authorization gaps
+* Token handling
+* Password storage
+* Secret management
+* Input validation
+* Session security
+* Sensitive logging
+* Injection vulnerabilities
+
+Provide actionable recommendations.
+
+---
+
+# Example 11 - Production Incident
+
+## User Request
+
+```
+Production API is returning HTTP 500 errors.
+```
+
+## Expected Behavior
+
+The AI should:
+
+1. Gather logs.
+2. Identify failing requests.
+3. Determine the root cause.
+4. Assess user impact.
+5. Recommend a safe fix.
+6. Suggest rollback if necessary.
+7. Add regression tests.
+8. Recommend monitoring improvements.
+
+---
+
+# Example 12 - Legacy Code Modernization
+
+## User Request
+
+```
+Modernize this Java 8 service to Java 21.
+```
+
+## Expected Behavior
+
+Update:
+
+* Language features
+* APIs
+* Dependencies
+* Deprecated methods
+* Performance improvements
+
+Maintain backward compatibility where required.
+
+---
+
+# Example 13 - Explain Existing Code
+
+## User Request
+
+```
+Explain how this module works.
+```
+
+## Expected Behavior
+
+Describe:
+
+* Overall purpose
+* Architecture
+* Data flow
+* Main classes
+* Dependencies
+* Potential issues
+* Suggested improvements
+
+Avoid rewriting code unless requested.
+
+---
+
+# Example 14 - Full Feature Development
+
+## User Request
+
+```
+Implement user profile management.
+```
+
+## Expected Behavior
+
+Deliver:
+
+* Database schema
+* Entity models
+* Service layer
+* Repository
+* REST API
+* Validation
+* Security
+* Logging
+* Unit tests
+* Integration tests
+* Documentation
+
+---
+
+# Example 15 - AI Coding Assistant
+
+## User Request
+
+```
+Implement the requested feature while following project conventions.
+```
+
+## Expected Behavior
+
+The AI should:
+
+* Read the existing codebase.
+* Follow naming conventions.
+* Reuse existing utilities.
+* Avoid duplicate implementations.
+* Keep changes minimal.
+* Add tests.
+* Explain implementation decisions.
+* Summarize modified files.
+
+---
+
+# Success Criteria
+
+A successful response should:
+
+* Solve the requested problem.
+* Follow project conventions.
+* Produce production-quality code.
+* Include appropriate testing.
+* Consider security and performance.
+* Minimize unnecessary changes.
+* Explain significant decisions.
+* Be ready for code review.