Document Sections Tooltips PRD

Owned by Megan Brehman (Unlicensed)
Last updated: Jan 26, 2018
4 min read


TypeIMPROVEMENT
Target release
Product Jira 
Product ownerMegan Brehman (Unlicensed)
UX/UI designer
Developer Approver
QA Approved
Editions


PHASE 1: VALIDATION 

GOALS

What problem are we trying to solve? 

Conducting our usability testing interviews, we discovered that users are confused by the Summary section.

  • Users didn't understand the meaning of Summary.
  • They felt that this section needed tooltips or an explanation.
  • Users requested a list of sections.
  • They didn't comprehend what the plus sign meant. 

What’s the goal of this improvement?

The goal of this improvement is to clarify the Summary section for the user. 

RESEARCH

Review analytics to validate assumptions. Conduct research to understand why we should develop the feature.

Participants from Intermétrica / Sanmina / THOMSON REUTERS all voiced confusion with Sections. 


USERCUSTOMEREXAMPLES
DavidIntermétrica
  • Summary means description and it doesn't say enough

  • The + sign is not as intuitive as I would expect

  • I understand a section as a part of the document
  • I think that the save button will only save the section where i am working on and not the rest of the document
  • I would like the events to be selected as sections
  • I don't understand why it does not show all the sections
PatricioIntermétrica
  • I dont know how to add a section - I see a plus here - when I go here I dont have any tooltip
  • Concept of sections, its not mentioned on screen
  • It would be nice to know what sections have been created
  • You have to try it and fail to understand how it works
  • A list of sections that I created would be nice to have - Summary doesnt say anything to me - I'm lost here - I need a list of sections I created so I can edit or delete them
  • I dont understand why I have to choose from this
  • It disappears

  • Sections most important

EberhardTHOMSON REUTERS
  • I dont understand 'New Section'
  • What is summary, sections? 

    This participant found it especially difficult to understand. He wasn't able to figure out what the Summary and plus sign were for. Once he poked around further, he was able to get a general grasp of the section. He requested a list of Sections. 



What’s the priority for this feature— why is it more important than others?

The priority for this improvement is critical. Creating sections to document the process is the point of the Process Documenter. We need to user to understand what this feature is and how to use it. 

What does this feature do? (this is applicable only to new features)

N/A

Who is this feature for? How many users will benefit?

Survey and usability testing participants agreed that Process Documenter would benefit anyone using ProcessMaker.

When asked Who in your company do you think would benefit from this plugin? survey participants responded: 

How does it improve the product? How does it relate to our overall product strategy?

It improves the UI and increases the user's ability to understand the tool.  

What technical, business or user assumptions are we making?

  • Technical: We're assuming that we know the best way to improve the functionality. 
  • Business: We're assuming that this is important from a business persceptive - i.e. customers might not purchase because of this. 
  • User: We're assuming that other users will have this problem as well.



*** IMPORTANT: Feature must be validated before moving forward ***


PHASE 2: REQUIREMENTS



#REQUIREMENTTYPEPriorityDESCRIPTION
1



2



3



4



5



6




USER PERSONAS

Business Users, Architects

USER STORIES


#TITLEUSER STORYPRIORITYNOTES
1



2



3



4



5




USER FLOWS 

PHASE 3: DESIGN + REVIEW

UI SPECIFICATIONS + MOCKUPS


Tooltips should look and work like the tooltips in the Designer. The user can activate the tooltips 2 ways

  • Clicking the ? icon for a tooltip walk-through
  • When the user scrolls over the area, relevant tooltips will appear with information about that area 


TooltipTooltip area Tooltip text 
1.Process Details (or Information) 

Add details about the process elements. The information can be configured to appear for all elements in all processes or just some elements in all processes in the workspace.

2.Overview

You can include an Overview of the entire process in the text editor.

3.+ tab

Click on the + tab to add details for each element in the process.

4.Text Editor

In the text editor, enter details about the element and format the text.


The tooltips 

Examples 




MOCKUPS                                  

Jira TICKET


(insert mockups)


REVIEW STATUS



STAKEHOLDER APPROVAL




Notes:


  • Change Summary to Overview
  • Section details (or information) 


Tooltip walk-through – scroll-over or click-through 

  1. Section details (or information) title - Add sections to include information about the process elements. The sections can be configured to appear for all elements in all processes or just some elements in all processes in the workspace.
  2. Overview - You can include an Overview of the process in the text editor.
  3. + tab - Click on the + tab to add sections for each element in the process.
  4. Text Editor - Enter information about the element and format the text.


RISKS + QUESTIONS

We need to be aware of any significant, known risks that the project faces. I.e. Are there business requirements unrelated to how the software functions? Do the developers need to take any special parameters into consideration? Is the feature going to be formally announced and if so, when should we engage marketing?


#QUESTIONREPORTERRESOLUTION
1


2


3


4



WHAT WE'RE NOT DOING + FUTURE IDEAS

We also want to detail what this feature does NOT do. This helps us make sure we're considering every aspect. Here we can also capture ideas for the future and how the feature might evolve.




METRICS

How do we measure success? What metrics do we need to instrument and track? We need to put proper tracking in place upfront to measure the outcome of our feature. Unless we know exactly what our users are doing, we won't know how to improve. 

List 3 main questions. These will also be our key metrics — to help us understand how our feature or improvement is doing.


#QUESTIONMETRICOUTCOME
1


2


3



References