Page MenuHomePhabricator

Copy: Evaluate each of the bits of informational text in the function view and edit UX, and whether we need them at all or should update them
Closed, DuplicatePublic

Description

right now, we are using copy in two places:
(1) the function view page
(2) the function edit page

We should determine if we want to keep using these and add them in other object view/edit pages and the creation page, or remove it all together

Event Timeline

Could you specify which copy? Do you mean:

  1. wikilambda-special-define-function-summary ("A function contains a definition, possibly…"), or
  2. wikilambda-special-edit-function-definition-description ("You are editing the function definition page.…"),
  3. wikilambda-function-about-summary ("This function turns an English singular word…"),
  4. wikilambda-special-createzobject-intro ("Make sure that you follow community policies, and copyright…"), or

The third is a placeholder for the documentation work in Phase Iota; the last was one of the bits be agreed with Legal ages ago. The first two are from Aishwarya I believe, but from a long time ago, and we might want to modernise and tighten them as well as use them more consistently.

Or did you mean something else?

I mean (1) and (2). Notably, (2) shows up even if it is NOT a function definition, so that should be changed. @aminalhazwani had mentioned potentially just getting rid of that copy altogether.

Jdforrester-WMF renamed this task from evaluate copy use to Evaluate each of the bits of informational text in the function view and edit UX, and whether we need them at all or should update them.Jul 19 2022, 9:04 PM
MShilova_WMF changed the task status from Open to Stalled.Aug 22 2022, 3:17 PM
gengh changed the task status from Stalled to Open.Sep 6 2022, 2:42 PM

To follow up to @JKieserman above, here’s my proposal.

Function viewer (Read tab):

  • About tab
    • Remove > “This is where the summary of the function's description will go, once that feature is available. It will let you explain why the function exists, how it is often used, and what alternatives might work better for different situations. In edit mode, this will be a multi-lingual editable wikitext box.”
      • Why? I wouldn’t tell users what they *can’t* do in advance, or what they will be able to do in the “future”.
  • Details tab
    • Remove > “ Anyone can propose a new implementation or test. Proposed code is reviewed by the Wikifunctions community before it becomes an available implementation or verified test. Learn more about the review process.”
      • Why? We don’t need to let users know what they can do. If they have the proper rights to do something we can let the UI speak for us. If they see the UI for adding an implementation or test it means that they can do it.
    • Remove > “ Anyone can edit labels, but the input/output type and count can only be edited by users with special permissions.”
      • Why? Same as above. If they can only edit the labels we don’t need to let them know with an additional text. We can however let them know in context if we think it’s necessary. For example when they try to edit the input/output type.

Function editor (Edit source tab):

  • Function definition tab
    • Remove > “ You are editing the function definition page. Only users with special permissions can change the definiton of the function. Everyone else can edit the labels. Make sure to save your work by clicking the blue Publish button below.”
      • Why? Same as above. Let the UI speak for us.

To answer James’ question:

  1. I assume from -special that I don’t have the rights to see this, but we can remove this copy as explained above.
  2. Same as 2.
  3. Is this the same as “ This is where the summary of the function's description will go…”. If yes, I would show the summary only if available. I would not show a placeholder in the function viewer if no summary is available.
  4. If possible, I would move this to publish component and publish workflow.

Generally speaking, since the UI is changing a lot, and since I would suggest to prioritize a self-explanatory UI rather than additional copy, I would like to propose to remove all non-UI existing copy. We can then, as we test the core user journeys, add accompanying help text as necessary.

What do you all think of this proposal?

Looping in also @SWoodruff-WMF as this might touch on her research and design explorations on making features more usable, discoverable, and accessible.

Quick question, on the details tab, does the link "Learn more about the review process.” go anywhere, or is this something that does not exist yet?

"Generally speaking, since the UI is changing a lot, and since I would suggest to prioritize a self-explanatory UI rather than additional copy, I would like to propose to remove all non-UI existing copy"

+1 to all of Amin's comments here.

Some of these can also be resolved or covered by what I'm exploring with Notifications/alerts

For example, on the function definition tab, different states based on user permissions

  1. If a user has full permissions, don't show text at all, it'll be clear from the UI what they can edit
  2. If a user doesn't, and then attempts to change the definition of the function, show notification text that says something along the lines of "You don't have permission to edit function definitions"

(and then link to information about different user permissions --- same q as above, is this a real link yet?)

(Or, better yet, don't even show the function definition as editable unless the users has appropriate permissions)

Screen Shot 2022-09-20 at 2.04.06 PM.png (1,732×1,316 px, 175 KB)

Side note, we might not need this helper text either

Quick question, on the details tab, does the link "Learn more about the review process.” go anywhere, or is this something that does not exist yet?

My assumption is that it will link somewhere like this https://en.wikipedia.org/wiki/Wikipedia:Reviewing but for Wikifunctions. I do wonder thou if this is the right place to display such content. What if we expose this information in either the registration process, or the publishing component?

  1. If a user has full permissions, don't show text at all, it'll be clear from the UI what they can edit

Totally agree!

If a user doesn't, and then attempts to change the definition of the function, show notification text that says something along the lines of "You don't have permission to edit function definitions"
(Or, better yet, don't even show the function definition as editable unless the users has appropriate permissions)

+1 also here. The only thing that we might want to explore is the scenario where an editor has (expressed) interest in getting the appropriate permissions. If we show the UI no matter what, the notification might be a good place to redirect editors who desires to get the proper editing rights.

gengh renamed this task from Evaluate each of the bits of informational text in the function view and edit UX, and whether we need them at all or should update them to Copy: Evaluate each of the bits of informational text in the function view and edit UX, and whether we need them at all or should update them.Oct 10 2022, 9:44 AM

As reported by @JKieserman

After creating a new implementation, I get redirected to the main page and am see a text box that reads “Please add an implementation and a test to see results” but…I just added an implementation. This copy should be more specific to avoid confusion (same thing for tester page). It also isn’t clear what this is referring to.

The whole message is this:

"wikilambda-tester-no-results": "No test results found. Please add an implementation and a test to see results."