ideas:usercomments

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
ideas:usercomments [2012/09/05 08:43]
googleguy Added Section for New User Notes Features
ideas:usercomments [2012/09/09 09:36]
googleguy [New User Notes Features]
Line 77: Line 77:
  
  
-----+===== New User Notes Features =====
  
- 
-==== New User Notes Features ==== 
  
 Since starting work on improving usernotes I've managed to find some good ways to implement some of the proposed features and improve on the existing system without introducing new backwards-compatibility breaks. None of the new features have gone into production on php.net as of yet, but hopefully will be introduced soon once some of the implementation details have been worked out and more thoroughly tested. To get an idea of the new features you can try the sandboxed demo here at [[http://​php.sheriframadan.com/​]] Since starting work on improving usernotes I've managed to find some good ways to implement some of the proposed features and improve on the existing system without introducing new backwards-compatibility breaks. None of the new features have gone into production on php.net as of yet, but hopefully will be introduced soon once some of the implementation details have been worked out and more thoroughly tested. To get an idea of the new features you can try the sandboxed demo here at [[http://​php.sheriframadan.com/​]]
Line 94: Line 92:
   - **Sorting**   - **Sorting**
     * The existing user notes were always sorted by date of submission in descending order. This made the usefulness of older notes degrade slowly over time as more and more notes for the same page were added and notes of a lesser quality were not removed.     * The existing user notes were always sorted by date of submission in descending order. This made the usefulness of older notes degrade slowly over time as more and more notes for the same page were added and notes of a lesser quality were not removed.
-    * The new features allows the notes to be sorted by a rating system of +/- 1 based on number of votes and grouped by dates in a descending order. ​So a note with a +1 rating ​(based on say +2 up-votes and +1 down-votes), submitted ​year ago, would still show up on top of any notes that were submitted as recently as today that haven'​t received an equal or larger positive ratingSimilarly negative ​ratings ​cause notes to drop to the very bottom of the page keeping cluttered ​notes readily sorted ​for each manual page+    * The new features allows the notes to be sorted by a rating system of +/- 1 based on number of votes and grouped by dates in a descending order. ​The rating is calculated by dividing the number of +1 (up votes) by the number of total votes (up votes plus down votes) ​-- calculated as percentage ​of 0 - 100%. 
-  - **Ease of use**+    * Notes that have no votes at all are ranked above notes with 30% or lesser ratingsNotes with greater than 30% ratings ​are ranked above notes with no votes at all. 
 +    * There is a slight exception ​to the rule with notes that have fewer than 4 votes. This way notes can not drop suddenly ​to the bottom of the page without some fair chance (trying to account for error in small sample sizes). 
 +    * Another exception to the rule is notes submitted on today'​s date. They'​re always left at the top for that day to give them a fair chance of exposure as well and hopefully collect a good rating sample
 +  - **Minor Improvements**
     * Some additional minor improvements have been introduced to allow usernotes to bring a more positive experience to the user.     * Some additional minor improvements have been introduced to allow usernotes to bring a more positive experience to the user.
-    * For example, visiting direct link to one of the notes such as [[http://​php.net/​strstr#​107588]] causes the anchor to direct the UA to the part of the page that contains this note ID. With some added javascript the page will now highlight the note for the user in an effort to direct ​their attention ​to the specific note they were looking for (or possibly where they were being directed to).+    * For example, visiting direct link to one of the notes such as [[http://​php.net/​strstr#​107588]] causes the anchor to direct the UA to the part of the page that contains this note ID. With some added javascript the page will now highlight the note for the user in an effort to focus their attention ​on the specific note they were looking for (or possibly where they were being directed to). 
 +    * User notes now also provide a timestamp in relative date format (e.g. "1 month ago", "2 years ago", "4 days ago", etc...) instead of a formated date timestamp (e.g "​2012-09-05"​).
     * Now, usernotes also helps make the experience of using its features easier to navigate with javascript in the cases of voting, and flagging user notes. The user does not have to leave the page to do so as long as they have javascript enabled. The functionality also degrades gracefully in the event javascript is not enabled on the client side. The next step will be to make adding notes also possible without leaving the page in the near future.     * Now, usernotes also helps make the experience of using its features easier to navigate with javascript in the cases of voting, and flagging user notes. The user does not have to leave the page to do so as long as they have javascript enabled. The functionality also degrades gracefully in the event javascript is not enabled on the client side. The next step will be to make adding notes also possible without leaving the page in the near future.
 +    * Also, you can now see how many notes have been added to each page at the top of the notes div (giving you some indication of number of notes per section without scrolling or counting the notes manual). Might be useful to some people.
     * More improved UX is also in the works :)     * More improved UX is also in the works :)
  
 Some of the current faced involve the decentralized manner in which the usernotes system is implemented in order to be distributed to the mirrors without requiring each mirror to retian it's own database and without centralizing a database that integrates into all of the mirrors. Since the entire notes system is primarily file-based and remotely synchronized there'​s no easy solution to authentication. The best proposed solution so far is OAuth 2.0, which can work, but might still require some centralized database in order to prevent some potential misuse such as the //confused deputy problem//. Some of the current faced involve the decentralized manner in which the usernotes system is implemented in order to be distributed to the mirrors without requiring each mirror to retian it's own database and without centralizing a database that integrates into all of the mirrors. Since the entire notes system is primarily file-based and remotely synchronized there'​s no easy solution to authentication. The best proposed solution so far is OAuth 2.0, which can work, but might still require some centralized database in order to prevent some potential misuse such as the //confused deputy problem//.
ideas/usercomments.txt · Last modified: 2017/09/22 13:28 (external edit)