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

Provide contextual help #6590

Closed
tbsbdr opened this issue Mar 14, 2022 · 2 comments · Fixed by #6750
Closed

Provide contextual help #6590

tbsbdr opened this issue Mar 14, 2022 · 2 comments · Fixed by #6750
Assignees

Comments

@tbsbdr
Copy link
Contributor

tbsbdr commented Mar 14, 2022

Description

User Stories

  • As a user who does not know what a ui-element indicates, I want help without having to leave my current context.

Value

  • Make the UI more accessible
  • Provide Help

Acceptance Criteria

  • ? - icon next to various elements
  • click on icon shows a tooltip (kind of)
  • click outside the tooltip hides the tooltip
  • tooltip can contain bold text, linebreaks, paragraph, un- and ordered lists and links
  • The helptext can be translated
  • Different Texts can be shown depending on oc10 or oCIS as backends
  • ideally PNG/JPG/GIF can be added to the tooltip if this is feasible within reasonable efforts.

Add help to the following places:

Share

Where?

  • Sidebar -> "Share (former People)" -> Invite (?)

Help text:

Invite persons or groups to access this file or folder.
- Enter a name or group to share this item
- If you share a folder,  all of its contents and subfolders will be shared with the entered persons or groups
- Invited persons or groups will be notified via e-mail or in-app notification
- Invited persons can not see who else has access
[Read more](https://deep-link-to-user-manual)

Add member

Where?

  • Space: Sidebar -> "Members" -> Add member (?)

Help text:

Add persons or groups as members to this Space.
Members are allowed to:
- see who else is member of this space
- view all files in this space
- (if permitted) edit or delete files in this Space
- (if permitted) share folders of this Space with non-Members
- see with whom a folder is shared
Members can only be added or removed by a Space Manager.
[Read more](https://deep-link-to-user-manual)

Share via link (ocis only)

Where?

  • Sidebar -> "Share" -> Share via link (?)

Help text:

Share a file or folder by link. Choose how access is granted:
- Only invited people can access: Only people from the list "Invited people" can access. If there is no list, no people are invited yet.
- Everyone with the link: Everyone with the link can access. Note: If you share this link with people from the list "Invited people", they need to login-in so that their individual assigned permissions can take effect. If they are not logged-in, the permissions of the link take effect.

[Read more](https://deep-link-to-user-manual)

Quick link

Where?

  • Sidebar -> "Share" -> Share via link -> Quick link (?)

Help text:

The Quick link is the link that is always copied if you 
- right click on a file and choose "Get link" or
- click on the quickaction "Get link"
[Read more](https://deep-link-to-user-manual)

Add link

Where?

  • Sidebar -> "Share" -> Share via link -> add link (?)

Help text:

Add and manage multiple links for the same file or folder.
[Read more](https://deep-link-to-user-manual)

Definition of ready

[ ] everybody needs to understand the value written in the user story
[ ] acceptance criteria has to be defined
[ ] all dependencies of the user story need to be identified
[ ] feature should be seen from an end user perspective
[ ] user story has to be estimated
[ ] story points need to be less then 20

Definition of done

  • Functional requirements
    [ ] functionality described in the user story works
    [ ] acceptance criteria are fulfilled
  • Quality
    [ ] codre review happened
    [ ] CI is green
    [ ] critical code received unit tests by the developer
    [ ] automated tests passed (if automated tests are not available, this test needs to be created and passed
  • Non-functional requirements
    [ ] no sonar cloud issues

image

@exalate-issue-sync exalate-issue-sync bot changed the title Provide Popup Helptexts Provide contextual help Mar 14, 2022
@tbsbdr
Copy link
Contributor Author

tbsbdr commented Mar 24, 2022

example from trello, well done imo:

2022-03-24_09-42-06.mp4

@tbsbdr
Copy link
Contributor Author

tbsbdr commented Mar 30, 2022

Example from google maps:
Initial:
image

Focused:
image

on-click:
image

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

Successfully merging a pull request may close this issue.

2 participants