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 75bf011 commit 55e849f
Showing 1 changed file with 26 additions and 21 deletions.
47 changes: 26 additions & 21 deletions full-stack-capstone-readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,68 +5,73 @@

## UX Design Process
- **Link to User Stories in GitHub Projects:**
- [Add a link to the GitHub Projects kanban board]
- [Add a link to the GitHub Projects kanban board.]
- **Wireframes:**
- [Attach or link to wireframes used in the design process.]
- [Explain the rationale behind the layout and design choices depicted in the wireframes.]
- [Attach or link to accessible wireframes used in the design process, ensuring high color contrast and alt text for visual elements.]
- [Explain the rationale behind the layout and design choices, focusing on usability and accessibility for all users, including those using assistive technologies.]
- **Design Rationale:**
- [Explain key design decisions, such as layout, color scheme, and typography.]
- [Discuss how accessibility guidelines (e.g., WCAG) were integrated.]
- [Explain key design decisions, such as layout, color scheme, typography, and how accessibility guidelines (e.g., WCAG) were integrated.]
- [Highlight any considerations made for users with disabilities, such as keyboard navigation and screen reader support.]
- **Reasoning For Any Final Changes:**
- [Summarize significant changes made to the design during development and the reasons behind them.]
- [Reflect on how these changes enhance inclusivity and accessibility.]

## Key Features
- **Feature 1:** [Briefly describe the implemented feature.]
- **Feature 2:** [Briefly describe the implemented feature.]
- **Inclusivity Notes:**
- [Mention how the features address the needs of diverse users, including those with SEND.]

## Deployment
- **Platform:** [Platform used, e.g., Heroku, AWS, etc.]
- **High-Level Deployment Steps:**
1. [Step 1]
2. [Step 2]
3. [Step 3]
- **Verification and Validation:**
- Steps taken to verify the deployed version matches the development version in functionality.
- [Include any additional checks to ensure accessibility of the deployed application.]
- **Security Measures:**
- Use of environment variables for sensitive data.
- Ensured DEBUG mode is disabled in production.

## AI Implementation and Orchestration

### Use Cases and Reflections:

(As part of your reflections, highlight the different types of prompts you used to achieve your project goals, and the benefits these brought. E.g.: Reverse, Question and Answer, and Multi-Step prompts)
(Highlight how prompts were used to support learners with SEND or ALN where relevant.)

- **Code Creation:**
- Reflection: Strategic use of AI allowed for rapid prototyping, with minor adjustments for alignment with project goals.
- Reflection: Strategic use of AI allowed for rapid prototyping, with minor adjustments for alignment with project goals.
- Examples: Reverse prompts for alternative code solutions and question-answer prompts for resolving specific challenges.
- **Debugging:**
- Reflection: Key interventions included resolving logic errors and enhancing maintainability.
- Reflection: Key interventions included resolving logic errors and enhancing maintainability, with a focus on simplifying complex logic to make it accessible.
- **Performance and UX Optimization:**
- Reflection: Minimal manual adjustments were needed to apply AI-driven improvements, which enhanced application speed and user experience.
- Reflection: Minimal manual adjustments were needed to apply AI-driven improvements, which enhanced application speed and user experience for all users.
- **Automated Unit Testing:**
- Reflection: Adjustments were made to improve test coverage and ensure alignment with functionality.

- **Overall Impact:**
- Reflection: Adjustments were made to improve test coverage and ensure alignment with functionality. Prompts were used to generate inclusive test cases that considered edge cases for accessibility.

Reflect on how:
- **Overall Impact:**
- 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.
- Challenges included contextual adjustments to AI-generated outputs, which were resolved effectively, enhancing inclusivity.

## Testing Summary
- **Manual Testing:**
- **Devices and Browsers Tested:** [List devices and browsers, e.g., Chrome, Firefox, Safari.]
- **Devices and Browsers Tested:** [List devices and browsers, ensuring testing was conducted with assistive technologies such as screen readers or keyboard-only navigation.]
- **Features Tested:** [Summarize features tested manually, e.g., CRUD operations, navigation.]
- **Results:** [Summarize testing results, e.g., "All critical features worked as expected."]
- **Results:** [Summarize testing results, e.g., "All critical features worked as expected, including accessibility checks."]
- **Automated Testing:**
- Tools Used: [Mention any testing frameworks or tools, e.g., Django TestCase.]
- Features Covered: [Briefly list features covered by automated tests.]
- Adjustments Made: [Describe any manual corrections to AI-generated test cases.]
- Adjustments Made: [Describe any manual corrections to AI-generated test cases, particularly for accessibility.]

## Future Enhancements
- [List any potential improvements or additional features for future development.]
- [List potential improvements or additional features for future development.]
- Consider enhancements to improve accessibility further, such as voice input capabilities or additional language support.

## Documentation Process
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.
1. **Wireframes, mockups, and diagrams** that are accessible and showcase the initial design and reasoning behind it.
2. Changes made during development, ensuring alignment between design and implementation.
3. AI tool usage, detailing its role in code creation, debugging, optimization, and testing, with a focus on prompt strategies.
4. Final implementation details, demonstrating adherence to design principles and accessibility standards.
4. Final implementation details, demonstrating adherence to design principles, accessibility standards, and inclusivity for diverse learner needs.

0 comments on commit 55e849f

Please sign in to comment.