|
5 | 5 |
|
6 | 6 | ## UX Design Process
|
7 | 7 | - **Link to User Stories in GitHub Projects:**
|
8 |
| - - [Add a link to the GitHub Projects kanban board] |
| 8 | + - [Add a link to the GitHub Projects kanban board.] |
9 | 9 | - **Wireframes:**
|
10 |
| - - [Attach or link to wireframes used in the design process.] |
11 |
| - - [Explain the rationale behind the layout and design choices depicted in the wireframes.] |
| 10 | + - [Attach or link to accessible wireframes used in the design process, ensuring high color contrast and alt text for visual elements.] |
| 11 | + - [Explain the rationale behind the layout and design choices, focusing on usability and accessibility for all users, including those using assistive technologies.] |
12 | 12 | - **Design Rationale:**
|
13 |
| - - [Explain key design decisions, such as layout, color scheme, and typography.] |
14 |
| - - [Discuss how accessibility guidelines (e.g., WCAG) were integrated.] |
| 13 | + - [Explain key design decisions, such as layout, color scheme, typography, and how accessibility guidelines (e.g., WCAG) were integrated.] |
| 14 | + - [Highlight any considerations made for users with disabilities, such as keyboard navigation and screen reader support.] |
15 | 15 | - **Reasoning For Any Final Changes:**
|
16 | 16 | - [Summarize significant changes made to the design during development and the reasons behind them.]
|
| 17 | + - [Reflect on how these changes enhance inclusivity and accessibility.] |
17 | 18 |
|
18 | 19 | ## Key Features
|
19 | 20 | - **Feature 1:** [Briefly describe the implemented feature.]
|
20 | 21 | - **Feature 2:** [Briefly describe the implemented feature.]
|
| 22 | +- **Inclusivity Notes:** |
| 23 | + - [Mention how the features address the needs of diverse users, including those with SEND.] |
21 | 24 |
|
22 | 25 | ## Deployment
|
23 | 26 | - **Platform:** [Platform used, e.g., Heroku, AWS, etc.]
|
24 | 27 | - **High-Level Deployment Steps:**
|
25 | 28 | 1. [Step 1]
|
26 | 29 | 2. [Step 2]
|
27 | 30 | 3. [Step 3]
|
| 31 | +- **Verification and Validation:** |
| 32 | + - Steps taken to verify the deployed version matches the development version in functionality. |
| 33 | + - [Include any additional checks to ensure accessibility of the deployed application.] |
28 | 34 | - **Security Measures:**
|
29 | 35 | - Use of environment variables for sensitive data.
|
30 | 36 | - Ensured DEBUG mode is disabled in production.
|
31 | 37 |
|
32 | 38 | ## AI Implementation and Orchestration
|
33 | 39 |
|
34 | 40 | ### Use Cases and Reflections:
|
35 |
| - |
36 |
| -(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) |
| 41 | +(Highlight how prompts were used to support learners with SEND or ALN where relevant.) |
37 | 42 |
|
38 | 43 | - **Code Creation:**
|
39 |
| - - Reflection: Strategic use of AI allowed for rapid prototyping, with minor adjustments for alignment with project goals. |
| 44 | + - Reflection: Strategic use of AI allowed for rapid prototyping, with minor adjustments for alignment with project goals. |
| 45 | + - Examples: Reverse prompts for alternative code solutions and question-answer prompts for resolving specific challenges. |
40 | 46 | - **Debugging:**
|
41 |
| - - Reflection: Key interventions included resolving logic errors and enhancing maintainability. |
| 47 | + - Reflection: Key interventions included resolving logic errors and enhancing maintainability, with a focus on simplifying complex logic to make it accessible. |
42 | 48 | - **Performance and UX Optimization:**
|
43 |
| - - Reflection: Minimal manual adjustments were needed to apply AI-driven improvements, which enhanced application speed and user experience. |
| 49 | + - Reflection: Minimal manual adjustments were needed to apply AI-driven improvements, which enhanced application speed and user experience for all users. |
44 | 50 | - **Automated Unit Testing:**
|
45 |
| - - Reflection: Adjustments were made to improve test coverage and ensure alignment with functionality. |
46 |
| - |
47 |
| -- **Overall Impact:** |
| 51 | + - 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. |
48 | 52 |
|
49 |
| - Reflect on how: |
| 53 | +- **Overall Impact:** |
50 | 54 | - AI tools streamlined repetitive tasks, enabling focus on high-level development.
|
51 | 55 | - Efficiency gains included faster debugging, comprehensive testing, and improved code quality.
|
52 |
| - - Challenges included contextual adjustments to AI-generated outputs, which were resolved effectively. |
| 56 | + - Challenges included contextual adjustments to AI-generated outputs, which were resolved effectively, enhancing inclusivity. |
53 | 57 |
|
54 | 58 | ## Testing Summary
|
55 | 59 | - **Manual Testing:**
|
56 |
| - - **Devices and Browsers Tested:** [List devices and browsers, e.g., Chrome, Firefox, Safari.] |
| 60 | + - **Devices and Browsers Tested:** [List devices and browsers, ensuring testing was conducted with assistive technologies such as screen readers or keyboard-only navigation.] |
57 | 61 | - **Features Tested:** [Summarize features tested manually, e.g., CRUD operations, navigation.]
|
58 |
| - - **Results:** [Summarize testing results, e.g., "All critical features worked as expected."] |
| 62 | + - **Results:** [Summarize testing results, e.g., "All critical features worked as expected, including accessibility checks."] |
59 | 63 | - **Automated Testing:**
|
60 | 64 | - Tools Used: [Mention any testing frameworks or tools, e.g., Django TestCase.]
|
61 | 65 | - Features Covered: [Briefly list features covered by automated tests.]
|
62 |
| - - Adjustments Made: [Describe any manual corrections to AI-generated test cases.] |
| 66 | + - Adjustments Made: [Describe any manual corrections to AI-generated test cases, particularly for accessibility.] |
63 | 67 |
|
64 | 68 | ## Future Enhancements
|
65 |
| -- [List any potential improvements or additional features for future development.] |
| 69 | +- [List potential improvements or additional features for future development.] |
| 70 | +- Consider enhancements to improve accessibility further, such as voice input capabilities or additional language support. |
66 | 71 |
|
67 | 72 | ## Documentation Process
|
68 | 73 | This README reflects the UX design process, deployment steps, and the development lifecycle:
|
69 |
| -1. **Wireframes, mockups, and diagrams** that showcase the initial design and reasoning behind it. |
| 74 | +1. **Wireframes, mockups, and diagrams** that are accessible and showcase the initial design and reasoning behind it. |
70 | 75 | 2. Changes made during development, ensuring alignment between design and implementation.
|
71 | 76 | 3. AI tool usage, detailing its role in code creation, debugging, optimization, and testing, with a focus on prompt strategies.
|
72 |
| -4. Final implementation details, demonstrating adherence to design principles and accessibility standards. |
| 77 | +4. Final implementation details, demonstrating adherence to design principles, accessibility standards, and inclusivity for diverse learner needs. |
0 commit comments