hasadna / open-bus-map-search

open-bus-map-search
https://open-bus-map-search.hasadna.org.il/dashboard
MIT License
56 stars 90 forks source link

Improve descriptions on top of each page #109

Open NoamGaash opened 1 year ago

NoamGaash commented 1 year ago

Our users doesn't understand the data shown on different pages. We will need some text contributions describing what's going on.

The text will need approval - we have volunteers with legal understanding, but it could take more time than other contribution. Yet, this contribution is vital.

ways to contribute -

  1. write the text here - https://docs.google.com/document/d/1jCXtb4T1uNpI8D23p-nAogorb8YVg_dsx0DKZJXj160/edit?usp=sharing
  2. translate/rephrase a text
  3. add text to the code by making a pull request. the text can be inside a <section> tag or inside a <Tooltip> component
    • [x] dashboard page
    • [x] timeline page
    • [x] gaps page
    • [x] gaps_patterns page
    • [x] map page
    • [ ] single-line-map page
    • [x] about page

thank you all!

ArkadiK94 commented 1 year ago

A short welcoming description for the dashboard page, using ChatGPT ( If it is ok, I will continue for the other pages as well.)

English: "Welcome to our platform dedicated to providing accurate bus schedules and real-time departure updates, all to ensure a more reliable and convenient bus service. Users can contribute by reporting issues like late, missed, or non-arriving buses, fostering a community-driven effort towards a better bus travel experience for all."

Hebrew: "ברוכים הבאים לפלטפורמה שלנו שמטרתה ( החלפתי מ"המקודשת") לספק לוחות זמנים מדויקים של האוטובוסים ועדכוני יציאה בזמן אמת, הכל כדי להבטיח שירות אוטובוסים אמין ונוח יותר. המשתמשים יכולים לתרום על ידי דיווח על בעיות כמו איחורים, נסיעות שלא עצרו או שלא התקיימו, תוך יצירת מאמץ משותף שמטרתו לשפר את חוויית הנסיעה באוטובוס עבור כולם."

Screenshot_20231106_160021_ChatGPT.jpg

NoamGaash commented 1 year ago

This message is very generic, I'm not sure it describe what's seen on this page

ArkadiK94 commented 1 year ago

In my opinion, we should add a welcome page / section in the dashboard so users will know the general purpose of the site. Also, I will do something more specific for what we see in the dashboard. Is it ok that I use chatgpt for that?

NoamGaash commented 1 year ago

Sure, my only concern is the text quality. I want users to understand what they're seeing. Have you seen the "about" page?

ArkadiK94 commented 1 year ago

English: "The dashboard, featuring multiple information blocks, allows you to set a time range and access insights on bus operators' success rates in meeting scheduled times, identifying poor-performing operators and bus lines, and viewing charts depicting the percentage of bus operators departing from all scheduled lines for specific days or hours."

Hebrew: "לוח המחוונים, המכיל מספר קטעי מידע, מאפשר לכם לקבוע טווח זמן ולקבל מידע על אחוזי הצלחה של מפעילים בהתאמה לשעות היציאה המתוזמנות, זיהוי של מפעילים וקווי אוטובוס פחות יעילים, והצגת תרשימים המתארים את אחוזי היציאות של המפעילות אוטובוס המתוזמנים לימים או שעות ספציפיים."

ArkadiK94 commented 1 year ago

What do you think? It is for the dashboard, I add here the screen shot from chatgpt.

Screenshot_20231106_164434_ChatGPT.jpg

ArkadiK94 commented 1 year ago

I thought about better approach to solve this issue. Let's make a drive word file in which every one could suggest changes to the texts. I can write the first texts and people could correct them /write better formats. 🤔

ArkadiK94 commented 1 year ago

Sometimes, it is easier to correct someone than writing from start 😁

NoamGaash commented 1 year ago

Feel free to edit https://docs.google.com/document/d/1jCXtb4T1uNpI8D23p-nAogorb8YVg_dsx0DKZJXj160/edit?usp=sharing

ArkadiK94 commented 11 months ago

@NoamGaash By mistake, I changed the permissions of all users to be able only to comment before I added myself a permission to edit. Could you add only for me the permission to edit?

NoamGaash commented 11 months ago

The document? Anyone can contribute. That's on purpose

ArkadiK94 commented 11 months ago

@NoamGaash Hmm, I would like to share this file in the discord and also it is here in the github. So it is open for scammers to change the text as they wish. I prefer that only few people could edit it and the others will have the permission to add a comment/suggestion.

With that said, If you still want that everyone could edit this file. Please, change back the permissions in the file.

NoamGaash commented 11 months ago

@ArkadiK94 right now, anyone with link can comment. image It's a common practice

ArkadiK94 commented 11 months ago

@NoamGaash By mistake, I changed the permissions of all users to be able only to comment before I added myself a permission to edit. Could you add only for me the permission to edit?

Yup, I did it. Could you add me that I will also be able to edit?

shootermv commented 10 months ago

We have a descriptions at almost all pages now... @NoamGaash is there more things to be done in here?

NoamGaash commented 10 months ago

@shootermv it's not about having description, it's more about what's in the description... phrases like "תפקוד תחבורה ציבורית לפי פרמטרים שונים" doesn't really say anything.

shootermv commented 10 months ago

@shootermv it's not about having description, it's more about what's in the description... phrases like "תפקוד תחבורה ציבורית לפי פרמטרים שונים" doesn't really say anything.

personally i think it is now better than before (when there was no explanations) but sure there is certainly a place for improvement... so, now it is more - make a descriptions of the pages more explanatory task (which requires some other skills than react knowledge), am i right?

NoamGaash commented 10 months ago

That's true, The issue isn't react. it's about providing information to the user

itai-rozen commented 9 months ago

ive added some hebrew & english descriptions in the attached google docs. let me know what you think:)

NoamGaash commented 9 months ago

@itai-rozen looks great, let's hope someone will implement it :)

itai-rozen commented 9 months ago

For sure i will, i wanted to hear some more opinions. Gonna also change headers in navbar to match headers in pages

בתאריך יום ו׳, 2 בפבר׳ 2024, 20:18, מאת Noam Gaash ‏< @.***>:

@itai-rozen https://github.com/itai-rozen looks great, let's hope someone will implement it :)

— Reply to this email directly, view it on GitHub https://github.com/hasadna/open-bus-map-search/issues/109#issuecomment-1924442099, or unsubscribe https://github.com/notifications/unsubscribe-auth/AKX42SZDCD4YJC2MCZZYBLLYRUUX5AVCNFSM6AAAAAA53PYK7KVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMYTSMRUGQ2DEMBZHE . You are receiving this because you were mentioned.Message ID: @.***>

NoamGaash commented 9 months ago

@itai-rozen I believe in incremental improvements - those texts will (most probably) change in the future. Yet, that's a huge step toward better user experience, and implementing that will be great