Product Documentation

• User Roles

• Calculation Engine

• TDM_Calculator_System_Design_Full-draft
  • This document establishes the system design baseline for the TDM Calculator, serving as a source of truth for system behavior, FAQs, and onboarding content for end users, LADOT stakeholders, and current and future contributors. It covers the application's core concepts, collaboration model, submission workflow, program guidelines versioning, and key design constraints and tradeoffs.

Pages/elements on the website

• Login
  • Registration - aka Create an Account
  • Update Account
  • Forgot Password
• My Projects
• Create Project
• About
• Security
  • Archive Projects
  • Archive Accounts
• Submissions
• Manage Submissions
• FAQ
• Feedback
• Terms and Conditions
• Privacy Policy
• Checklist
• Navigation
• [Credits] - this will be added via https://github.com/hackforla/tdm-calculator/issues/2681

Functions

• Snapshots
• [Search] - This page should show all the search box that appear on pages with project tables (My Projects, Managing Submissions, Submissions, Feedback, Security) - this will be added via https://github.com/hackforla/tdm-calculator/issues/2888

Page Access by Role

• Spreadsheet TDM: Page Access by Role defines View, Use, and Edit permissions by role: All Users, Visitors, Logged-In, Admin, Security.

Style Guide for components on pages

• Figma wiki page, Style Guide section

---

Template for making future wiki pages in this Product Documentation

Copy template

### [Name of page]
- [DETAILS]
- [DETAILS]

### URLS
- Dev URL: https://tdm-dev.azurewebsites.net/[ADD PAGE NAME] (INDICATE USER ACCESS REQUIRED)
- Prod URL: https://tdm.ladot.lacity.org/[ADD PAGE NAME]
- GitHub location: [repo:hackforla/tdm-calculator "[ADD PAGE NAME]"][GO TO THIS LINK AND CHANGE THE PAGE NAME IN THE SEARCH BAR AND THEN REPLACE URL (https://github.com/search?q=repo%3Ahackforla%2Ftdm-calculator+%22Archived+Accounts%22&type=code)]
- Figma Design: 
  - WIKI [TDM Calculator Figma Pages and Structure](https://github.com/hackforla/tdm-calculator/wiki/Figma) 
  - Figma [TDM Calculator Figma Pages and Structure, User-Facing Screens]
  - Figma [TDM Calculator Handoff, User-Facing Screens]

### User Access
- Requires sign in: [REPLACE WITH TRUE OR FALSE]
- Can access page directly from URL: [REPLACE WITH TRUE OR FALSE]
- User Profile Required for [ADD PAGE NAME] page: [REPLACE WITH USER TYPE: visitor (not logged in)/user/admin/security admin/]
   - to see all pages that user types can access [TDM: Page Access by Role](https://docs.google.com/spreadsheets/d/1kzIV46hBB7IULKxaB0aY15sCRHa3j_Ksa9fj96BKaWI/preview)

### Issue label
- [label:"p-feature: ADD PAGE NAME ON LABEL" on Issue tab][GO TO THE ISSUE TAB AND SELECT THE LABEL AND THEN ADD THE URL IN THE PARENTHESIS()]
- [label:"p-feature: Submissions and process" on Project Board][GO TO THE PROJECT BOARD AND SELECT THE LABEL AND THEN ADD THE URL IN THE PARENTHESIS()]


### Screen shots of page

### Technical Details

### Files that mention Checklist and how they interact

#### Core Files

#### Other files