Difference between revisions of "Documentation-Rons-Rules-For-Tools"
From Slicer Wiki
(Created page with '=Introduction= Rules for tools is an informal set of rules that developers should keep in mind when working on interactive tools for translational clinical research. If you follo…') |
|||
| Line 3: | Line 3: | ||
*Your tool works when it works on my laptop with my data. Until then its useless to me. | *Your tool works when it works on my laptop with my data. Until then its useless to me. | ||
| − | *Make sure your module sets up | + | *I am lazy. Make my life easy. |
| − | *No more than one parameter that I can set. If I need more than 20 seconds to figure | + | **Minimize the number of clicks |
| − | *If I can take my lunch break while your algorithm is running, I won't return. | + | **Minimize the distance my pointer has to travel |
| + | **Make sure your module sets up everything for me, but allow me to override. | ||
| + | **E.g. if you create an output file, use the input filename plus name of the module. | ||
| + | *No more than one parameter that I can set. If I need more than 20 seconds to figure out how to set the parameter, I won't! | ||
| + | *If I can take my lunch break while your algorithm is running, I won't return to it. | ||
Revision as of 14:01, 5 February 2010
Home < Documentation-Rons-Rules-For-ToolsIntroduction
Rules for tools is an informal set of rules that developers should keep in mind when working on interactive tools for translational clinical research. If you follow them, you will create tools that many people can use.
- Your tool works when it works on my laptop with my data. Until then its useless to me.
- I am lazy. Make my life easy.
- Minimize the number of clicks
- Minimize the distance my pointer has to travel
- Make sure your module sets up everything for me, but allow me to override.
- E.g. if you create an output file, use the input filename plus name of the module.
- No more than one parameter that I can set. If I need more than 20 seconds to figure out how to set the parameter, I won't!
- If I can take my lunch break while your algorithm is running, I won't return to it.
