Documentation

[amfairley]

README.md

• [ ] Introduction: Site Logo, Aim, Target Audience, Framework, Link to site, Mock-up image
• [x] Project goals: User goals, site owner goals, developer goals
• [x] User Stories: Viewing and Navigation, Registration and User Accounts, Sorting and Searching, Purchasing and Checkout, Admin and Store page
• [ ] Security: Defensive Programming, Future Security Implementations
• [ ] Future Developments
• [ ] Technologies Used: Languages, Frameworks, Libraries and Packages, Tools
• [ ] User Feedback
• [ ] Credits
• [ ] Acknowledgements

DESIGN.md Five Planes of UX

• [x] Strategy: What value does the project provide, what are the business needs, who is the target audience, what are the user requirements and expectations, viability and feasibility
• [x] Scope: Back-end (tables in database), Front-end (list of html pages and their uses)
• [x] Structure: Each page and their layout, Information architecture (back-end: database schema, front-end: site map with key points discussed), Interactive Experience
• [x] Skeleton: Wireframes for the each page
• [ ] Surface: Colour Scheme (layout of colour scheme, table for each use), Typography, Images Features
• [ ] For each feature: Feature Name, Which page it is found on, Details, Which User Story it covers

TESTING.md

• [x] Introduction to testing procedure, automated vs manual testing, and TDD procedure, coverage
• [x] Testing user stories (short intro, numbered user story and how the requirement is met)
• [ ] Manual testing (Feature/Action/Expected Results/Passed/Comments)
• [ ] Device and Browser Testing: Google Chrome Devtools for responsivity and mimic devices, Browsers tested, Devices used to test, Peer testing devices and browsers
• [ ] Automated testing:
• [ ] TDD
• [ ] Accessibility testing WAVE Results per page and errors/alerts explained
• [ ] Performance Testing: Describe procedure and efforts taken to improve performance, Lighthouse test each page (results in separate document). Comment on <100 results
• [ ] HTML Validation: Description and list of warnings. Then a list of screenshot results.
• [ ] CSS Validation: Description and results
• [ ] JavaScript Validation: Description and Results
• [ ] Python Validation: Description, Describe Errors, Results for each .py file
• [ ] Bugs: Issue (with code)/ Fix (changed code)
• [ ] Known Bugs
• [ ] Analytics: Describe google analytics with code snippet

DEV.md

• [x] CI/CD: Description, Version Control, Projects
• [x] Developer Environment: How To, Creating a Django Project, Python pep8 requirements
• [x] Local development: Link to instructions and then how to fork
• [ ] Deployment:

[amfairley]

Aim/Target Audience/Framework crossed off for README.md Introduction.

[amfairley]

Cross off back-end scope.