Changes between Version 36 and Version 37 of GSoC/Ideas


Ignore:
Timestamp:
03/21/11 22:37:34 (3 years ago)
Author:
mitar
Comment:

Legend:

Unmodified
Added
Removed
Modified
  • GSoC/Ideas

    v36 v37  
    3333Level from 1 (beginner) to 5 (professional): 4 
    3434 
    35 == Documentation proofreading and improvement == 
     35== Documentation proofreading and improvement with code examples == 
    3636 
    37 We have quite a lot of documentation for different aspects of Orange (widgets, scripting...) and of course a lot of it is still missing/incomplete/could be improved a lot. But some things could be done already on existing documentation, like checking the language itself (we are not English native speakers), proofreading, checking if all examples (still) really work, find new and/or better examples and so on. 
     37We have quite a lot of documentation for different aspects of Orange (widgets, scripting...) and of course a lot of it is still missing/incomplete/could be improved a lot. But some things could be done already on existing documentation, like checking the language itself (we are not English native speakers), proofreading and so on. 
     38 
     39Along it and important aspect should be also checking if all examples (still) really work and come up with new and/or better examples. Maybe also integrate them with our unit tests for the code. We also have GUI and more schema examples (saved state of Orange canvas with all widgets, etc.) for it would be useful. 
     40 
     41So in short: more and better examples along with documentation. Maybe even stand-alone example scripts. 
    3842 
    3943This could be also a good project if you would like to learn more about Orange and data mining and machine learning itself. 
    4044 
    41 Useful skills: Proficiency in English (probably native speaker). Language/writing skills. 
     45Useful skills: Proficiency in English (probably native speaker). Language/writing skills. Python. 
    4246 
    4347Level from 1 (beginner) to 5 (professional): 3 
    44  
    45 == Documentation screen casts == 
    46  
    47 Current documentation of Orange widget is static. There are about a 100 widgets, all of them are described with screen shots and in text. This is a bit boring, and often does not provide much help for a really novice users. We believe that this is where Orange could shine. It is a really simple to use system, but current documentation fails to present it in this way. We would instead need fresh, informative screen casts, each no longer than 2 minutes, explaining what each widget does, how can it be integrated in a useful schema. The screen casts should probably show the narrator in first person, describing the problem that the widget solves in first person, and then focusing on a schema with an example.  
    48  
    49 The screen casts would then be included in the documentation of widgets, but would also be available in each widget by clicking on Help button. The project would in this way develop a tagged library of screen, probably published on YouTube. 
    50  
    51 Useful skills: English proficiency. Video and sound editing. Talent for staging. Some knowledge of data mining. 
    52  
    53 Level from 1 (beginner) to 5 (professional): 2 
    5448 
    5549== A social platform for Orange ==