311-data icon indicating copy to clipboard operation
311-data copied to clipboard

UXW - review FAQ content

Open jberzowska opened this issue 5 months ago • 9 comments

Overview

We need to revise the FAQ page to ensure it is searchable, up to date and reflects how the 311DATA app will work at launch.

Dependency

  • [x] UX Writer needs 1Password credentials

Action Items

  • [x] Review FAQ content
    • [ ] check that our current answers still reflect how the city runs the 311 service.
  • [x] Add new questions & answers that explain how our app works
  • [x] Add page metadata
  • [ ] Review with PMs & Design
  • [x] Update the Hand Off section of this ticket with document link
  • [ ] Save the updates as draft in the CMS and hand off to product team for QA and approval.
    • [ ] consider opening a new ticket for PM team to act on content review

Hand Off Materials

Draft files, including columns for

  • Current copy
  • Suggested metadata, updates & new question copy
  • Rationale
  • Feedback from PMs and Design

Work in progress

Resources

  • https://hackforla.github.io/311-data/#/faqs

jberzowska avatar Aug 07 '25 21:08 jberzowska

Similar question as this ticket, needing to know more info on metadata. Can you share any info / articles on what metadata is important? Are the headings considered metadata?

  • see similar: https://github.com/hackforla/311-data/issues/2000#issuecomment-3199854932

ryanfchase avatar Aug 19 '25 09:08 ryanfchase

Otherwise, this ticket passes review. Once this is out of icebox and back into New Issue Approval, please add ready for prioritization label

ryanfchase avatar Aug 19 '25 09:08 ryanfchase

This week: I have set up the files for metadata and the FAQ review. No blockers. ETA: this ticket will be completed by September 17th.

WIP links:

jberzowska avatar Sep 08 '25 22:09 jberzowska

Ticket is partly ready for review (the FAQ doc is still in progress): @ryanfchase - could one of the devs to provide feedback on the feasibility of the metadata recommendation? @Joy-Truex - could you confirm that you're okay with the recommendation of using the project logo on social posts that include our url? If not, could you attach an alternate image to this ticket?

jberzowska avatar Oct 06 '25 23:10 jberzowska

Copying some extra questions posted to Slack today: @ryanfchase - I'm just jumping back into the FAQ page content and I had written down that you were investigating whether the search feature in the first orange box is needed/works. At this point, I don't feel it will be needed from a content POV. Can I go ahead and recommend we remove it from the page? Just let me know if you'd like me to say we might bring it back post-launch. @Joy-Truex - I'd also like to recommend we right-align "Expand All" with the expand arrows and format it as a secondary link. Any concerns from your end on that? I don't think we'll need a mock-up as long as I can include a screenshot of the correct link design. Can you send me an example we already have of that?

Image

jberzowska avatar Oct 07 '25 04:10 jberzowska

  • Right align- agree
  • as far a secondary link- will require further investigation to identify as our typeramp is still WIP due to previous member exiting the team; i can either work on this within this ticket or as a sub ticket. Id like to discuss with the design team at our breakout tonight, can provide an update after (Oct 8.)

Joy-Truex avatar Oct 08 '25 14:10 Joy-Truex

Update of decisions from today's team meeting:

  • We are good with the canonical url from a dev perspective
  • For social posts, we will use an updated screenshot of the app (like we have on https://www.hackforla.org/projects/311-data). We will take this screenshot shortly before launch
  • Since we will be launching with a smaller number of questions in the FAQ, the team agreed that we should remove the search feature for now. As a result, the header will look like the one on the About or Contact pages.

We do not yet have link styling for the expand all feature, but that is not launch-blocking (and likely not a priority for the design team.

cc. @ryanfchase @Joy-Truex

jberzowska avatar Oct 09 '25 03:10 jberzowska

The revised FAQ copy and metadata are both ready for review.

jberzowska avatar Oct 09 '25 05:10 jberzowska

We had a quick feedback session with Bonnie today. She was okay with the general approach of keeping the FAQ high-level, focused mostly on the app and linking to city sites for details, as appropriate. She did remind us that visitors need basic understanding of the 311 service to engage with the map.

We also introduced the metadata document at a high level and received some further feedback:

  • title: keep it shorter so that something meaningful can show up on the browser tab, make sure we cannot be confused with a city site
  • generally, see if we can introduce the idea of a citizen app (vs. official, volunteer led, etc.). Maybe something like Citizen Data App, or 311 by Citizens

She would like to review both documents once we have made updates.

jberzowska avatar Nov 14 '25 04:11 jberzowska