Skip to content

Commit

Permalink
Update full-stack-capstone-readme.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Mrbrianojee authored Jan 7, 2025
1 parent 6f4d3d0 commit 8aea552
Showing 1 changed file with 36 additions and 23 deletions.
59 changes: 36 additions & 23 deletions full-stack-capstone-readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
## UX Design Process
- **Wireframes:**
- [Attach or link to wireframes used in the design process.]
- [Briefly explain the rationale behind the layout and design choices depicted in the wireframes.]
- [Explain the rationale behind the layout and design choices depicted in the wireframes.]
- **Mockups:**
- [Include or link to mockups showcasing the visual design.]
- [Summarize how the mockups reflect the intended user experience and branding.]
Expand All @@ -16,7 +16,7 @@
- [Explain key design decisions, such as layout, color scheme, and typography.]
- [Discuss how accessibility guidelines (e.g., WCAG) were integrated.]
- **Reasoning for Changes:**
- [Summarize any significant changes made to the design during development and the reasons behind them.]
- [Summarize significant changes made to the design during development and the reasons behind them.]

## Key Features
- **Feature 1:** [Briefly describe the implemented feature.]
Expand All @@ -32,26 +32,38 @@
- Use of environment variables for sensitive data.
- Ensured DEBUG mode is disabled in production.

## Reflection on AI Tools Usage
## AI Tools Usage and Reflection

### Contributions of AI Tools
1. **Code Creation:**
- AI tools (e.g., GitHub Copilot) were used to generate initial drafts of models, views, and templates. Adjustments were made to align with project requirements.
2. **Debugging:**
- AI-assisted identification and resolution of code issues, saving significant debugging time.
3. **Optimization:**
- Suggestions from AI tools enhanced code readability and improved performance.
4. **Testing:**
- Generated unit tests for key features, with manual refinements for accuracy.
### AI in Code Creation
- **Use Case:** AI tools (e.g., GitHub Copilot) were used for generating initial drafts of models, views, and templates.
- **Reflection:**
- Strategic use of AI allowed for rapid prototyping of code components.
- Outcomes: Enhanced productivity with minor manual adjustments for alignment with project goals.

### Overall Impact
- **Successes:**
- Accelerated development with AI tools, especially in ideation and repetitive coding tasks.
- Streamlined debugging and validation processes.
- **Challenges:**
- Initial AI-generated code sometimes required significant contextual adjustments.
- **Workflow Improvement:**
- AI tools enabled a focus on high-level design and logic while automating repetitive tasks.
### AI in Debugging
- **Use Case:** AI tools assisted in identifying and resolving bugs in the code.
- **Reflection:**
- AI significantly reduced debugging time by providing context-aware suggestions.
- Key interventions included resolving logic errors and improving code readability.

### AI in Performance and UX Optimization
- **Use Case:** AI suggested performance improvements, including optimization of query efficiency and front-end responsiveness.
- **Reflection:**
- Suggestions improved application speed and user experience.
- Minimal manual intervention was needed to apply AI-driven improvements.

### AI in Automated Unit Testing
- **Use Case:** AI (e.g., GitHub Copilot) was utilized to generate Django unit tests for application features.
- **Reflection:**
- Generated test cases covered CRUD operations and authentication logic.
- Adjustments were made to improve test coverage and ensure accuracy.
- Demonstrated understanding of AI-generated test logic and its alignment with functionality.

### Overall Impact of AI
- **Reflection on Workflow:**
- AI tools streamlined repetitive tasks, enabling focus on high-level development.
- Efficiency gains included faster debugging, comprehensive testing, and improved code quality.
- Challenges included contextual adjustments to AI-generated outputs, which were resolved effectively.

## Testing Summary
- **Manual Testing:**
Expand All @@ -67,7 +79,8 @@
- [List any potential improvements or additional features for future development.]

## Documentation Process
This README reflects the UX design process, including:
1. **Wireframes, mockups, and diagrams** that showcase the initial design and the reasoning behind it.
This README reflects the UX design process, deployment steps, and the development lifecycle:
1. **Wireframes, mockups, and diagrams** that showcase the initial design and reasoning behind it.
2. Changes made during development, ensuring alignment between design and implementation.
3. Final implementation details, demonstrating adherence to design principles and accessibility standards.
3. AI tool usage, detailing its role in code creation, debugging, optimization, and testing.
4. Final implementation details, demonstrating adherence to design principles and accessibility standards.

0 comments on commit 8aea552

Please sign in to comment.