When the user first encounters the help panel after clicking a suggested edit, they will be on an article in read mode, and the panel will be displaying the "suggested edit screen". This screen will also display in edit mode. It is identical across the two modes, except for its footer. The actual written content of the screen is covered in T245786: Newcomer tasks: guidance written content.
The specifications here follow along with the corresponding prototypes. Where they differ, the written specifications take precedent:
Header and body
- Header: the header of the panel should read "Suggested edits"
- Header section
- Contains the edit type, e.g. "Copyedit" or "Find references"
- Contains the difficulty level, e.g. "Medium"
- Contains the estimated time, e.g. "3 - 5 minutes"
- Contains the suggested edit graphic of a pencil/ruler/lightbulb.
- This is exact same content that is used in the task explanation widget (T235046), shown in the screenshot below.
- This content should be displayed the exact same way in the mobile peek (see T244434).
- Quick start tips
- This is the only content on the panel in the first version.
- There should be a header that reads "Quick start tips". There should not be a chevron beside that header as shown in the prototype, because there won't be other content.
- There will be a series of tips that contain text, links, and potentially small images. The content and number of tips may need to vary between task types, platforms, languages, and editors. There will be no more than 8.
- The tips have numbered tabs starting at 1.
- The user can click on a tab to go to that tip.
- The content of the tips is covered in T245786: Newcomer tasks: guidance written content.
- The tips auto-advance every five seconds until the user has interacted with the panel in some way. Once the user interacts with the panel, the tips stay on whichever one they were on when the user interacted. This specification extends across the reading and editing experiences, i.e. if the user has not interacted with the panel in read mode, the tips should still be auto-advancing when the user gets to edit mode. This is covered in T253009
- FAQ: in the "..." overflow menu of the panel, there is an option labeled, "Suggested edit FAQ". It will link to this page.
This is the only way in which the suggested edit screen differs between read and edit mode.
- Read mode:
- On mobile, the footer says, "Ready? Tap the edit pencil on the article to start."
- On desktop, the footer says, "Ready? Click "Edit" to get started."
- Edit mode:
the footer contains a back button, which brings the user back to the root screen (see T244546: Newcomer tasks: guidance root screen).No footer (user navigates back to the root screen via the back arrow in the header)
Below are the portions of our instrumentation plan that relate to this component. See T246919: Newcomer tasks: guidance instrumentation for the full plan. The work to implement this will be done in T253010
- This screen displays on desktop when the user arrives on the article. On mobile, it displays when the user has tapped the mobile peek.
- impression: we want to record that the user saw the help panel and which set of content it displays, in terms of which “task type” it is guiding, and whether it is showing the desktop VE, mobile VE, desktop wikitext, or mobile wikitext content.
- clicks: we want to record exactly which tab the user clicks on when they click through the quick tips.
- auto-advance: the quick start tabs will advance automatically every five seconds until the user clicks one. We want to record an event for each auto-advance, indicating which tab it advanced to.
- link clicks: the suggested edit screen will contain links to help documents, to which we want to record clicks.