Difference between revisions of "WMF UX Improvement Effort"

From Kiwix
Jump to navigation Jump to search
 
(82 intermediate revisions by 2 users not shown)
Line 1: Line 1:
=== Phases ===
==== Phase 1 ====


==== Search engine phase (3/8/11 - 3/29/11) ====
Critical bugs phase (8/24/11 - 8/31/11)


{|{{Prettytable}}
{|{{Prettytable}}
Line 7: Line 7:


|- style="vertical-align: top;"
|- style="vertical-align: top;"
| #5 || '''[[#Google-styled search result page]]''' || Displaying the results in the sidebar is not good. We should display the results like google in a tab. || closed || 100% || || Medium || 20 hours
| #16 || '''Critical bugs''' ||  
* <s>[Kiwix for Windows crashby opening specific ZIM file]</s>
* <s>[Not possible on Windows to open a ZIM file if accented path]</s>
* <s>[Search engine does not always work on Windows]</s>
* <s>[Deal with relative paths in the library]</s>
|| closed || 100% || || Top || 20 hours
|}


|- style="vertical-align: top;"
==== Phase 2 ====
| #0 || '''[[#Search in text improvement]]''' || Better error message for search in page, possibly switching from dialog box to toolbar || closed || 100% ||  || Low || 20 hours
 
|- style="vertical-align: top;"
| #9 || '''[[#Search misses some articles]]''' || Some articles included in the Wikipedia Version 0.5 ZIM file I tested were not matched by searching and could only be viewed by clicking a link to them. || closed || 100% || || N/A || N/A


Feedback system (8/31/11 - 9/21/11)
{|{{Prettytable}}
! Task !! width="300px"| Title !! Description !! Next step !! Progress !! Bug !! Priority !! Difficulty
|- style="vertical-align: top;"
|- style="vertical-align: top;"
| #10 || '''[[#Unnecessary doubleclick by suggestions]]''' || If a match is chosen from the pop-up search suggestions, it should probably go ahead and execute that search rather than waiting for the user to hit enter. || closed || 100% || || Low || 2 hours
| #7 || '''Menu item feedback''' || In browser feedback || closed || 100% || || High || 2


|- style="vertical-align: top;"
|- style="vertical-align: top;"
| #12 || '''[[#Large search button should launch search in page]]''' || Currently executes search from search bar (see below) || closed || 100% ||[https://sourceforge.net/tracker/?func=detail&aid=3098294&group_id=175508&atid=873518] || High || 1 hour
| #8 || '''Post download feedback''' || Post content download || open || 100% || || High || 4


|- style="vertical-align: top;"
|- style="vertical-align: top;"
| #x || '''Add small search button inside search field''' || Similar to Firefox, Explorer, Wikipedia, for searching entire ZIM file. This function is currently done by the large search button (see above) || closed || 100% ||[https://sourceforge.net/tracker/?func=detail&aid=3098294&group_id=175508&atid=873518] || High || 1 hour
| #9 || '''Feedback system''' || Supporting in browser and post download || closed || 100% || || High || 40
 
|- style="vertical-align: top;"
| #x || '''Allow multzim search and make it configurable''' || || concept || 0% || || Low || 15 hours


|}
|}


==== Q/A Cycle (3/29/11 - 4/5/11) ====
==== Phase 3 ====
 
==== Integrated Downloader phase (4/5/11 - 5/4/11) ====


Filtering and Sorting (9/21/11 - 9/28/11)
{|{{Prettytable}}
{|{{Prettytable}}
! Task !! width="300px"| Title !! Description !! Next step !! Progress !! Bug !! Priority !! Difficulty
! Task !! width="300px"| Title !! Description !! Next step !! Progress !! Bug !! Priority !! Difficulty
|- style="vertical-align: top;"
|- style="vertical-align: top;"
| #40 || '''[[#Download Platform]]''' || Finish the download platform using mirrorbrain and provide a working metalink solution. || realization || 0% || || Medium || 10 hours
|- style="vertical-align: top;"
|- style="vertical-align: top;"
| #41 || '''[[#New library manager]]''' || The library manager is the intern component/piece of code which provides all the necessary API to deal with content. This will be used by kiwix, kiwix-serve and kiwix-library. Should be in c++, using a small/fast/portable XML parser. For kiwix an XPCOM component should be done. || concept || 80% || [https://sourceforge.net/tracker/?func=detail&aid=3064386&group_id=175508&atid=873515] || High || 20 hours
| #5 || '''Filters and sorting''' || Add ability to filter and sort listed ZIM files || closed || 100% || || Low || 15


|- style="vertical-align: top;"
|- style="vertical-align: top;"
| #42 || '''[[#kiwix-manage]]''' || Kiwix-manage in a new console tool to setup the library.xml file which lists content files available for download. [[Kiwix-library|More infos...]]|| realization || 80% || || High || 20 hours
| #6 || '''Searching''' || Add ability to search available ZIM files (title and description) || closed || 100% || || Low || 15


|- style="vertical-align: top;"
|}
| #43 || '''[[#User Interface]]''' || Introducing a user interface listing content available offline and online (to download). This user provides for each content an overview and gives the possibility to download/load/delete the content. || concept || 70% || [https://sourceforge.net/tracker/?func=detail&aid=2987622&group_id=175508&atid=873518] || Medium || 20 hours


|- style="vertical-align: top;"
==== Phase 4 ====
| #44 || '''[[#Downloader core]]''' || The downloader core is the piece of code dealing with the aria2c binary. Responsible for downloading/sharing the content. || realization || 0% || ||High  || 20 hours


|- style="vertical-align: top;"
{|{{Prettytable}}
| #45 || '''[[#Document Feed Format]]''' || Document feed [[FeedFormat|format]]. || drafting || 0% || || Low || XX


|- style="vertical-align: top;"
|- style="vertical-align: top;"
| #46 || '''Filters and sorting''' || Add ability to filter and sort listed ZIM files || concept || 0% || || Low || XX
| #12 || '''KPIS''' || Implement KPIS || pause || 30% || || Low || 20


|- style="vertical-align: top;"
|- style="vertical-align: top;"
| #47 || '''Searching''' || Add ability to search available ZIM files (title and description) || concept || 0% || || Low || XX
| #15 || '''Distribution''' || Easier workflow for local distribution<br/> * <s>build kiwix-install</s><br/> * <s>improve build-kiwix-release.sh and provide ZIP files for each ZIM file</s><br/> * <s>Write the documentation about how to use the tools</s><br.>* port the tools on OSX<br/> || || 90% || || Low || 40


|}
|}


==== Q/A Cycle (5/4/11 - 5/11/11) ====
==== Backlog ====
 
==== Last phase (5/11/11 - 5/31/11) ====
 


{|{{Prettytable}}
{|{{Prettytable}}
Line 71: Line 63:


|- style="vertical-align: top;"
|- style="vertical-align: top;"
| #1 || '''[[#Bad MacOSX Quit menu item]]''' || MacOSX Quit menu item in File menu is odd to see || closed || 100% || [https://sourceforge.net/tracker/?func=detail&aid=3165259&group_id=175508&atid=873515] || ||  
| #1 || '''[[#Revamp the help page]]''' || The help page must be more complete, more ''sexy'', with screenshots. It should also provide an easy way to download new content. || proposal || 0% || || Low || 30 hours


|- style="vertical-align: top;"
|- style="vertical-align: top;"
| #2 || '''[[#Dead "adding content" link in the help]]''' || "Adding Content" paragraph does not exist in the Help page in English || closed || 100% || [https://sourceforge.net/tracker/?func=detail&aid=3165272&group_id=175508&atid=873515] || || 2 hours
| #2 || '''[[#Kiosk mode]]''' || It would also be cool to have a kiosk mode available in which the interface would be fullscreen unless a special keyboard command was issued. || discussion || 0% || || low || 5 hours


|- style="vertical-align: top;"
|- style="vertical-align: top;"
| #3 || '''[[#Revamp the help page]]''' || The help page must be more complete, more ''sexy'', with screenshots. It should also provide an easy way to download new content. || proposal || 0% || || || 30 hours
| #3 || '''[[#History navigator]]''' || You can purge your history, but you can't view it. It would be nice to be able to browse through your history either from a menu or the Sidebar.. || discussion || 0% || || Low || really depends what we want here. A few hours to get a simple list of pages but a lot of work if you want a mgmt tool.


|- style="vertical-align: top;"
|- style="vertical-align: top;"
| #6 || '''[[#Localization improvement]]''' || Kiwix has too few locales and it is too complicated to update them. || realisation || 30% || || || 20 hours
| #4 || '''Desktop File browser integration''' || ZIM file mime-type should be recognized as "application/x-zim", icon should be the kiwix one and double click on them should start kiwix and open the file. || closed || 100% || || Medium || 20 hours


|- style="vertical-align: top;"
|- style="vertical-align: top;"
| #7 || '''[[#ESC to quit Fullscreen]]''' || This should be possible to press ESC to qui the fullscreen. || closed || 100% || || ||  
| #10 || '''[[#Refine Kiwix UI]]''' || Improve the look and feel || || 0% || || Low || 20


|- style="vertical-align: top;"
|- style="vertical-align: top;"
| #8 || '''[[#User unfriendly index dialogbox]]''' || Change the invitation to index message to "This file does not include a search index. Creating one may take several minutes. Do you want to index your ZIM file now?". || closed || 100% || || ||  
| #11 || '''Upgrade to XUL 2.0''' || Upgrade to XUL runner 2.0 || || 0% || || Low || 40


|- style="vertical-align: top;"
|- style="vertical-align: top;"
| #11 || '''[[#Desktop File browser integration]]''' || ZIM file mime-type should be recognized as "application/x-zim", icon should be the kiwix one and double click on them should start kiwix and open the file. || realization || 50% || || || 20 hours
| #13 || '''Search''' || Improve search || || 0% || || Low || 40


|- style="vertical-align: top;"
|- style="vertical-align: top;"
| #13 || '''[[#Bad "transliteration" menuitem on OSX]]''' || || closed || 100% || [https://sourceforge.net/tracker/?func=detail&aid=3167823&group_id=175508&atid=873515] || ||  
| #14 || '''ePub''' || Add ePub support || || 0% || || Low || 60


|- style="vertical-align: top;"
|}
| #14 || '''[[#Unusual keyboard shortcuts on OSX]]''' || In the Mac version, the Keyboard shortcuts are not typical for a Mac application (normally the Command key is used rather than Control). Regardless, they do not actually work using either keys. || closed || 100% || || || 2 hours


|- style="vertical-align: top;"
== Posponed ==
| #15 || '''[[#History navigator]]''' || You can purge your history, but you can't view it. It would be nice to be able to browse through your history either from a menu or the Sidebar.. || discussion || 0% || || || really depends what we want here. A few hours to get a simple list of pages but a lot of work if you want a mgmt tool.


|- style="vertical-align: top;"
{|{{Prettytable}}
| #16 || '''[[#Back button wrong behaviour]]''' ||While it was indexing, I decided to try clicking some article links. This worked fine, although I was not able to return to the home page by using the back button. (Strangely this only happened the first time I left the home page. On subsequent attempts I was able to go back to the home page by clicking the back button.) || reprocase || 0% || ||  || 1 hour
! Task !! width="300px"| Title !! Description !! Next step !! Progress !! Bug !! Priority !! Difficulty


|- style="vertical-align: top;"
|- style="vertical-align: top;"
| #16 || '''[[#Preferences dialog box]]''' || It might be nice to have a preferences pane where you could set things like "Always show the tab bar", "Remember browsing history", etc.  || realization || 20% || || || depends what we want inside the preference dialog
| #1 || '''Allow multzim search and make it configurable''' || || concept || 0% || || Low || 20 hours


|- style="vertical-align: top;"
|- style="vertical-align: top;"
| #16 || '''[[#Kiosk mode]]''' || It would also be cool to have a kiosk mode available in which the interface would be fullscreen unless a special keyboard command was issued. || discussion || 0% || || low || 5 hours (must also be more detailed)
| #2 || '''Ability to build zim files''' || Implement a full pipeline for openZim files || grant request ongoing  || 0% || || Low || 500


|- style="vertical-align: top;"
|- style="vertical-align: top;"
| #16 || '''[[#DNS prefetching]]''' || although this isn't a user interface issue, it seems that Kiwix makes DNS requests on all the external links included in each Wikipedia article it loads (without clicking on them). So if I pull up World War II, for example, Kiwix might make a couple hundred DNS requests. This isn't bad for someone living in the US, but if you are in a remote area and don't have unlimited data for free, it could be an unexpected surprise, since Kiwix is supposed to be an "offline" reader. Just thought I would pass it along. || closed || 100% || || ||  
| #3 || '''Revamp bookmarks''' || Bookmarks needs to be rethink and reimplemented || proposal || 0% || || Low || 60


|}
|}


== Details ==
= Notes =


=== Search in text improvement ===
== Refine Kiwix UI ==


There is also a small bug: If the search term is not found, it returns an error saying "[JavaScript Application] The text you entered was not found." The "[JavaScript Application]" part should probably be removed or replaced. Ryan
Improve the appearence. Appearance is important to gain confidence in the software and make the whole user experience better. I propose here to involve here someone with design skills and propose to implement his proposition after discussion in the app. [[User:Kelson|Kelson]] 20:39, 22 August 2011 (CEST)


=== Bad MacOSX Quit menu item ===
Propositions:
* Better language switch menu organisation, they are now too much language in one list
* Still continue to improve the tabs design


=== Dead "adding content" link in the help ===
== Automate zim file generation ==


=== Revamp the help page ===
Work on a solution to fully automatize the generation of full ZIM files. We need to simply and multiply the generation of Full ZIM files. I have currently script, but I need something to build on the top (a good Makefile for example and afterward a Web UI) to make them simplier to use.


=== Download manager ===
== Open bugs ==


=== Google-styled search result page ===
Select a subset of bugs and improvment in the list we have build with our testers. They are a few bugs we *must* fix in the next release.


As previously discussed, Google-style search results would be a nice alternative to the current Sidebar implementation, especially if it could include a brief snippet from each article. Perhaps you could configure what type of search you prefer from a preferences menu. Ryan
== XUL 2.0 ==


=== Localization improvement ===
Migrate to xulrunner 2.0 to use the best of the Mozilla code and last improvments bug fix.


We will migration to translatewiki.net. We know how to make the migration, I still need to work on the migraation scripts, new templates and import scripts. [[User:Kelson|Kelson]] 13:02, 26 February 2011 (UTC)
== KPIS ==


=== ESC to quit Fullscreen ===
Implement KPIs. Is essential the measure the performance of the project, is also important for other sponsors.


=== User unfriendly index dialogbox ===
== Improve Search Engine ==


=== Search misses some articles ===
Improve the search engine... currently it's OK, but we could be better. Here a few possible improvments:
* integrating stop words
* search pattern words in bold
* better ranking


=== Unnecessary doubleclick by suggestions ===
== Archives ==
* [[/01-02-2011_01-01-06-2011|Season 1: Feb. to Jun. 2011]]


=== Desktop File browser integration ===
== See also ==
* [[User interface feedback]]


Gnome done, OSX, KDE and Windows still to do. [[User:Kelson|Kelson]] 14:12, 26 February 2011 (UTC)
[[category:projects]]
 
=== Large search button should launch search in page ===
It is not clear what the function of the large search button in the toolbar is. Usually that icon is associated with launching a "Search in page" feature. If someone assumes that that is its function, they will be confused when they click on it and nothing happens. Ideally the search box itself should have a small magnifying glass ''within'' the search box, like Firefox, Explorer, and Wikipedia, and the large search icon should launch the search in page dialog.
 
=== Bad "transliteration" menuitem on OSX ===
 
=== Unusual keyboard shortcuts on OSX ===
 
=== History navigator ===
 
=== Back button wrong behaviour ===
 
=== Preferences dialog box ===
 
Some settings ideas
 
* Font selection and size
: IMO this is the job of the ZIM publisher to provide such feature: he is responsible that the content is well displayed. This should/could be done using javascript/css/webfont/cookies pretty easily. I guess around 10 hours of work to introduce that option in my ZIM build process. The result would be a font selector on every page (for example on the top left corner) [[User:Kelson|Kelson]] 12:16, 6 April 2011 (UTC)
 
* Dont track history
* Online/Offline mode if external links are present. Would make links disappear if your in offline mode
* Default location for zim files
 
=== Kiosk mode ===
 
=== DNS prefetching ===
 
== See also ==
* [[User_interface_feedback]]
* [[/Testers]]

Latest revision as of 09:41, 18 April 2012

Phase 1

Critical bugs phase (8/24/11 - 8/31/11)

Task Title Description Next step Progress Bug Priority Difficulty
#16 Critical bugs
  • [Kiwix for Windows crashby opening specific ZIM file]
  • [Not possible on Windows to open a ZIM file if accented path]
  • [Search engine does not always work on Windows]
  • [Deal with relative paths in the library]
 closed 100% Top 20 hours

Phase 2

Feedback system (8/31/11 - 9/21/11)

Task Title Description Next step Progress Bug Priority Difficulty
#7 Menu item feedback In browser feedback closed 100% High 2
#8 Post download feedback Post content download open 100% High 4
#9 Feedback system Supporting in browser and post download closed 100% High 40

Phase 3

Filtering and Sorting (9/21/11 - 9/28/11)

Task Title Description Next step Progress Bug Priority Difficulty
#5 Filters and sorting Add ability to filter and sort listed ZIM files closed 100% Low 15
#6 Searching Add ability to search available ZIM files (title and description) closed 100% Low 15

Phase 4

#12 KPIS Implement KPIS pause 30% Low 20
#15 Distribution Easier workflow for local distribution
* build kiwix-install
* improve build-kiwix-release.sh and provide ZIP files for each ZIM file
* Write the documentation about how to use the tools<br.>* port the tools on OSX
 90% Low 40

Backlog

Task Title Description Next step Progress Bug Priority Difficulty
#1 #Revamp the help page The help page must be more complete, more sexy, with screenshots. It should also provide an easy way to download new content. proposal 0% Low 30 hours
#2 #Kiosk mode It would also be cool to have a kiosk mode available in which the interface would be fullscreen unless a special keyboard command was issued. discussion 0% low 5 hours
#3 #History navigator You can purge your history, but you can't view it. It would be nice to be able to browse through your history either from a menu or the Sidebar.. discussion 0% Low really depends what we want here. A few hours to get a simple list of pages but a lot of work if you want a mgmt tool.
#4 Desktop File browser integration ZIM file mime-type should be recognized as "application/x-zim", icon should be the kiwix one and double click on them should start kiwix and open the file. closed 100% Medium 20 hours
#10 #Refine Kiwix UI Improve the look and feel 0% Low 20
#11 Upgrade to XUL 2.0 Upgrade to XUL runner 2.0 0% Low 40
#13 Search Improve search 0% Low 40
#14 ePub Add ePub support 0% Low 60

Posponed

Task Title Description Next step Progress Bug Priority Difficulty
#1 Allow multzim search and make it configurable concept 0% Low 20 hours
#2 Ability to build zim files Implement a full pipeline for openZim files grant request ongoing 0% Low 500
#3 Revamp bookmarks Bookmarks needs to be rethink and reimplemented proposal 0% Low 60

Notes

Refine Kiwix UI

Improve the appearence. Appearance is important to gain confidence in the software and make the whole user experience better. I propose here to involve here someone with design skills and propose to implement his proposition after discussion in the app. Kelson 20:39, 22 August 2011 (CEST)

Propositions:

  • Better language switch menu organisation, they are now too much language in one list
  • Still continue to improve the tabs design

Automate zim file generation

Work on a solution to fully automatize the generation of full ZIM files. We need to simply and multiply the generation of Full ZIM files. I have currently script, but I need something to build on the top (a good Makefile for example and afterward a Web UI) to make them simplier to use.

Open bugs

Select a subset of bugs and improvment in the list we have build with our testers. They are a few bugs we *must* fix in the next release.

XUL 2.0

Migrate to xulrunner 2.0 to use the best of the Mozilla code and last improvments bug fix.

KPIS

Implement KPIs. Is essential the measure the performance of the project, is also important for other sponsors.

Improve Search Engine

Improve the search engine... currently it's OK, but we could be better. Here a few possible improvments:

  • integrating stop words
  • search pattern words in bold
  • better ranking

Archives

See also

Retrieved from "https://wiki.kiwix.org/w/index.php?title=WMF_UX_Improvement_Effort&oldid=4784"