hackforla / hackforla/tdm-calculator
Determine handover plan for product documentation
- Dominant language
- JavaScript
- Stars
- 68
- Forks
- 47
- Avg merge
- 3d 9h
- Merged PRs (30d)
- 25
Description
### Dependency
- [ ] revisit in April 2026
### Overview
We need a plan for handover of the TDM product documentation to the stakeholder so that they can use, expand, revise it post handover.
### Action Items
- [ ] Determine how to complete the info handover
- [ ] Are we adding it to the app itself?
- [ ] Are we adding it to MKDocs?
- [ ] Tell the stakeholder where it is on our Wiki so they can reference or copy from there
- [ ] Review with product and dev. and update if needed based on feedback
- [ ] Create a new issue to do the handover with details about the decision
### Resources/Instructions
- https://github.com/hackforla/tdm-calculator/wiki/Product-Documentation
#### Slides
- [Staging Deck](https://docs.google.com/presentation/d/1crZ3IxqA4hAu3qzD7ns93Ieuqjwh6wyEtuX_46cP-fg)
- ~[Staging Deck, slide 2158](https://docs.google.com/presentation/d/1crZ3IxqA4hAu3qzD7ns93Ieuqjwh6wyEtuX_46cP-fg/edit?slide=id.g3559020fafa_0_0#slide=id.g3559020fafa_0_0)~
- [Staging Deck, slide 2158](https://docs.google.com/presentation/d/1crZ3IxqA4hAu3qzD7ns93Ieuqjwh6wyEtuX_46cP-fg/edit?slide=id.g369bd596ef3_0_0#slide=id.g369bd596ef3_0_0)
- Release Deck
- [2025-05-13 Release Deck, slide 2158](https://docs.google.com/presentation/d/1u7-iTsYgBCimvq1JV8oc9MlFkGd9SepB19b4vciP7kg/edit?slide=id.g356267f36e6_0_314#slide=id.g356267f36e6_0_314)
- [2025-05-27 Release Deck, slide 2158](https://docs.google.com/presentation/d/1l3wrArtEihG2G9vSRif5WAo0hLA-meyTpkugP4FegDE/edit?slide=id.g358470f1c1f_0_60#slide=id.g358470f1c1f_0_60)
- [2025-06-10 Release Deck, slide 2158](https://docs.google.com/presentation/d/1s8XuD5jD-LnHMfh2GjfyJsw3w6n_CWl6Rye1uMzxAlw/edit?slide=id.g35d8111f4f7_0_0#slide=id.g35d8111f4f7_0_0)
- [2025-06-24 Release Deck, Slide 2158](https://docs.google.com/presentation/d/1hWM-PmNFhkipBFrlwDgsQtSXY3dxig7twEpT4BZZO9I/edit?slide=id.g36704bf0d5d_0_0#slide=id.g36704bf0d5d_0_0)
Contributor guide
Research direction
Start with the Product Documentation wiki and the linked staging and release decks. Determine with product and development whether the handover belongs in the app, MKDocs, or the wiki, then document the decision and create the detailed follow-up issue. Done means the handover approach is reviewed, agreed, and recorded for the stakeholder.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100