Documentation-voting
From TYPO3Wiki
| Teams R&D-Committee | This page belongs to DocTeam (Members|Contact). see our current activities |
| Support for good documentation is our mission. | |
| List Projects | The Documentation-manuals voting-project list pages | See Current Project Members, Wishlist |
| you can help if you like! |
Contents |
Our aim
original
original
We want to improve documentation for TYPO3.
What we would like to do is have the manuals on the typo3.org site put into a table listing so that they can be rated by users. What we want is an easy way to get a list of all TYPO3 manuals (not just Extension manuals) and have a way for people to rate each one as to how out of date it is.
Then, we can prioritize and manage getting manuals revised and up to date.
The rating
- needs no revision, good as it is
- needs minor revision
- needs major revision
So, we would like to see a table with a way for people to "vote" on what they think of the manual. This would be a 1 to 3 scale that would need to be updated every time someone votes.
The bug with T would need to be fixed, as well. Example: Typo3 Tutorial (typo3_tut) (contact: docteam) is not shown in the list but it is in TER.
Current State
This is the list of finished tasks.
- Virgil: check who of the typo3.org-Team to contact about this
- Daniel: Small wiki-page what carries this little project
- not needed, we try to use ratings-EXT: somebody who creates the UML-diagram and text for the developer(s)
- not needed, we use this wiki-page: add all todos in the bugtracker, find the right bugtracker-category for it, get access-right for the right to CLOSE an item when ready
Development info
For the form-handling we could use Formidable.
Test: is the ratings (ratings) (contact: dmitry) best for this? It has an API what is extendible, depends on TYPO3 4.1, PHP 5.1.
- DB ratings_data = uid +pid +tstamp +crdate +cruser_int +cruser_id +reference (text) +rating (int) +vote_count (int)
- DB ratings_iplog = uid +pid +tstamp +crdate +cruser_int +cruser_id +reference (text) + ip
- DB tt_news += ratings_enable (int)
- debugMode: While in debug mode, it is possible to remove entries from rating tables or change values there}}
Current Project Members
| Virgil Huston | virgil.huston - at - gmail.com | communication |
| Daniel Brüßler | danielb - at - typo3.com | wiki-page, todolist, check DB-structure of ratings-EXT |
| Daniel Costas - do you like to support this project? | dcostas - at - web.de | . |
Wishlist
We need several tasks for it. Every item is just some minuts to an hour, it just looks like much work.
- Daniels Tasks
- easy coding: check if the ratings-EXT allows to be 100 times on a page (see Development-section)
- usability: Create a page with 100 AJAX ratings-fields on a page. Easiest is to use very small tt_news entries for this, because ratings is already prepared for tt_news. Maybe it's needed to move the rating-box from detail-view to list-view.
- usability: rating-bar on left side, right side, or more than one rating-bar? Really three questions for each manual or just a general "how good is the manual"?
- layout: How shall the page with the ratings look? (with help of Photoshop or Linux Gimp)
- usability: What problem can be when we don't have rating-texts for all the manuals? In the moment there's just the rating-bar. The users can't enter a text like "mostly good, but section XX is bad". But: The more the people have to do the less ratings we get.
- extension of ratings-EXT: find somebody or two who like to do the PHP-programming - 1. add an extension for ratings so that the manual-records can be rated (key "manual_extensionkey" e.g. "manual_ajaxgroupsearch") , 2. integration in the extension that lists the manuals
- extension of ratings-EXT: find somebody who likes to create the CSS and HTML-Template
- extension for the TER-manual-listing: find somebody who likes to connect the listing (ter_doc or ter_doc_sxw?) with the ratings-EXT-view. (contact: Steffen Kamper, Ingo Renner)
- ask who likes to create the layout with Photoshop or Linux Gimp
- ask if a news-entry for this is OK to get more attention
- news-group entry in the needed mailinglist (maybe HCI for layout, dev for the extension-update, typo3org if somebody has a problem with this idea)
- when ready: find some people who check if it works with every platform and browser
- i could check if it works with linux (konqueror, ff2/ff3), windows xp (ff2, safari, opera, ie6, ie7) just send me a note maholtz 18:57, 19 May 2008 (CEST) -- thanks, Martin! --Daniel Brüßler 11:03, 20 May 2008 (CEST)
