hackforla / hackforla/tdm-calculator

Product: Create TDM Guide for Updating Strategy Tooltips.

Open
#3,322 2 comments 0 reactions 0 assignees View on GitHub
deck: staging draft feature: Product Documentation level: medium priority: SHOULD HAVE ready for product role: Product Management size: 3pt
Dominant language
JavaScript
Stars
68
Forks
47
Avg merge
3d 9h
Merged PRs (30d)
25

Description

### Overview
We need to write a document which explains how to update tooltips related to strategies, which will need to be shared with stakeholders

### Action Items
- [ ] Identify where strategy-related tooltips currently appear in TDM and review examples of existing tooltip language, formatting, and behavior.
- [ ] ~Research the current workflow for updating strategy tooltip content, including where the source content lives, who is responsible for approving changes, and what stakeholder input is needed.~
- [ ] Draft a process guide that explains how to update and validate strategy tooltip changes.
- [ ] Share the draft guide with relevant product/design/development stakeholders for review and incorporate feedback.
- [ ] Review with product and dev. 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.
- [ ] Add the finalized guide to the TDM wiki in the appropriate location, making sure it is clearly titled, easy to find, and linked from any related documentation.

### Resources/Instructions
- https://github.com/hackforla/tdm-calculator/pull/3320 - created migration script
- [Calculation Engine](https://github.com/hackforla/tdm-calculator/wiki/Calculation-Engine) - document that teaches how to update strategies (not their tooltips)

#### Staging and Release decks
- [Staging Deck](https://docs.google.com/presentation/d/1crZ3IxqA4hAu3qzD7ns93Ieuqjwh6wyEtuX_46cP-fg/)
- [Staging slide, 3322](https://docs.google.com/presentation/d/1crZ3IxqA4hAu3qzD7ns93Ieuqjwh6wyEtuX_46cP-fg/edit?slide=id.g3f2afe8206d_0_122#slide=id.g3f2afe8206d_0_122)
- Release Deck
- [2025-MM-DD Release deck, slide 3322]

Contributor guide

Open the contributing guide

Research direction

Start by reviewing the Calculation Engine wiki page and PR 3320 to understand the existing strategy-update context, then inspect the linked staging slide for issue 3322. Draft and validate the strategy-tooltip process guide, review it with product and development stakeholders, add before-and-after images, obtain stakeholder sign-off, and publish the finalized guide in the TDM wiki.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Active
Clarity
Mostly clear
Newbie friendliness
50/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.