hackforla / hackforla/tdm-calculator
Product: Revise Terminology in the FAQ
- Dominant language
- JavaScript
- Stars
- 68
- Forks
- 47
- Avg merge
- 3d 9h
- Merged PRs (30d)
- 25
Description
### Overview
We need to make the terminology in the FAQ use the current definitions
#### Details
We have used the terms for the following indiscriminately
- Project
- TDM Plan
- Draft
- Snapshot
### Action Items
- [ ] Go to FAQ and click Expand All (resource 1.01)
- [ ] Create full page screenshot using resource 1.02
- [ ] Download PDF
- [ ] Go to ChatGPT.com or other chat LLM
- [ ] Input PDF and the following prompt
```
I want to revise the FAQs on this PDF to use these definitions. Please provide the category and before and suggested after for each FAQ item.
- Project = user's real estate project
- TDM Plan = summary of project details and strategies the user submits to comply with the TDM Program Guidelines
- Draft = a draft TDM Plan in the Los Angeles’ Transportation Demand Management (TDM) Calculator
- Snapshot = finalized, immutable state of a TDM Plan draft. Snapshots are used for sharing and submission. Once a draft becomes a snapshot, it can no longer be edited directly.
```
- [ ] Copy response content and put it in a Google doc (resource 1.03)
- [ ] Review with product. Update if needed based on feedback
- [ ] Once finalized, add before and after images to the slide in the staging deck for this issue (see link under resources)
- [ ] Get Stakeholder sign-off via the stakeholder meeting slide deck.
### Resources/Instructions
- 1.01 https://tdm-dev.azurewebsites.net/faqs
- 1.02 https://gofullpage.com/
- 1.03 [FAQ: Revised Definitions](https://docs.google.com/document/d/1XqouaUzwSMP3OvkHYYRs6VxXFQVAUu0DaXBeI4wgOao/edit)
#### Definitions as of 2026-04-29
- Project = user's real estate project
- TDM Plan = summary of project details and strategies the user submits to comply with the TDM Program Guidelines
- Draft = a draft TDM Plan in the Los Angeles’ Transportation Demand Management (TDM) Calculator
- Snapshot = finalized, immutable state of a TDM Plan draft. Snapshots are used for sharing and submission. Once a draft becomes a snapshot, it can no longer be edited directly.
#### Staging and Release decks
- [Staging Deck](https://docs.google.com/presentation/d/1crZ3IxqA4hAu3qzD7ns93Ieuqjwh6wyEtuX_46cP-fg/)
- [Staging slide, 3155](https://docs.google.com/presentation/d/1crZ3IxqA4hAu3qzD7ns93Ieuqjwh6wyEtuX_46cP-fg/edit?slide=id.g3defaf3d508_51_7#slide=id.g3defaf3d508_51_7)
- Release Deck
- [2026-MM-DD Release deck, slide 3155]
Contributor guide
Research direction
Start at the FAQ page linked in resource 1.01 and compare each FAQ's terminology with the four definitions in the issue. Record before-and-after wording in the linked FAQ: Revised Definitions document, review it with product, then update the staging slide with before-and-after images and obtain stakeholder sign-off.
Written by the indexing model from the issue text.
Assessment
- Domain
- content, documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100