Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add a 'help/information' link for all quests #94

Closed
CloCkWeRX opened this issue Apr 4, 2017 · 4 comments
Closed

Add a 'help/information' link for all quests #94

CloCkWeRX opened this issue Apr 4, 2017 · 4 comments

Comments

@CloCkWeRX
Copy link

CloCkWeRX commented Apr 4, 2017

Similar:

ID does a pretty good job of this by adding an "Info" link into the UI:
image

For an individual quest, it could be useful to add a link into the UI pointing at the relevant openstreetmap wiki page.

IE:

public class AddRoadName extends OverpassQuestType {
   public String getHelpLink() {
      return "https://wiki.openstreetmap.org/wiki/Key:highway";
   }
   // ...
}

Alternatively, pointing to a specific quest set of documentation (similar to what is done with some HOT tasks) would also be useful.

hotosm/osm-tasking-manager2#979 talks about a similar usability need.

This could likely be represented in the UI in a consistent icon/location on each form.

@CloCkWeRX CloCkWeRX changed the title Add a 'view wiki' link for all quests Add a 'help/information' link for all quests Apr 4, 2017
@westnordost
Copy link
Member

westnordost commented Apr 5, 2017

I do not plan to add this because this app does not expose the user to the "raw" OSM tags, so linking a wiki site that talks about these tags is counter-productive. Rather, I want to design the UI in a way that it is self-explanatory. Where it is unavoidable, I add short explanation texts (i.e. in the "add road name" form).

Especially in the case of the building levels by the way, it would only confuse the user more (because the app is not asking for the values as they are input via the tags).

What I would probably eventually add, is a small info button for each quest (type), that pops up a dialog that explains in short words:

  • why is this mapped/asked at all? What's the use of this?
  • some words/pictures to clear up any misunderstandings, like a mini-FAQ for just this quest.

If this is about what you meant, I can leave this issue open, but a wiki link I would definitely not add.

@CloCkWeRX
Copy link
Author

CloCkWeRX commented Apr 6, 2017

If this is about what you meant,

Yeah, that's more the direction I was heading - arbitrary link - with the osm wiki documentation as a fallback of last resort

Check out https://www.openstreetmap.org/user/JanBohmMSF/diary/40072 as a 'how to' guide and it has a built in Q&A section as more of where I was going with it. Obviously, that's aimed at tasking manager and is complex, compared to what the design goal is here.

@CloCkWeRX
Copy link
Author

Sample explainer text to fix #89 #66
https://github.com/CloCkWeRX/StreetComplete/wiki/Building-Levels (can turn this into a PR if you want)

@westnordost
Copy link
Member

No, thank you. As said, I will rather make the quests self-explanatory than to add "guides".

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants