Difference between revisions of "Projects:RegistrationDocumentation"

From NAMIC Wiki
Jump to: navigation, search
Line 10: Line 10:
 
*Preferred formats:  Slicer Wiki, maybe PDF
 
*Preferred formats:  Slicer Wiki, maybe PDF
  
−
==User Manuals==
+
==User Manuals & Tutorials==
 +
*[[Projects:RegistrationDocumentation:VideoTutorials|Video Tutorials: showcase of specific workflow]]
 +
*Background Tutorials, explaining the basics of registration, formats: PowerPoint. Minimal understanding of the inner workings of a registration optimization algorithm is essential to understand and judge the results obtained and obtainable.
 
*this documentation will discussing the main registration module functionality as a whole, focusing not on the individual controls but the main workflow.
 
*this documentation will discussing the main registration module functionality as a whole, focusing not on the individual controls but the main workflow.
 
formats: Slicer Wiki, PowerPoint.  
 
formats: Slicer Wiki, PowerPoint.  
−
*Also included in this category are Background Tutorials, explaining the basics of registration, formats: PowerPoint. Minimal understanding of the inner workings of a registration optimization algorithm is essential to understand and judge the results obtained and obtainable.
 
−
==Training Video Tutorials==
 
  
−
[[Image:TrainingMovieThumbnail.jpg|thumb|frame| [[Media:VideoTutorialDemo_v1_0.mov|Training Movie Demo (1min)]]]]
 
−
*These movies contain step by step instructions, running through each of the use-cases described above.
 
−
*An example of the features/character of a video tutorial is here: [[Media:VideoTutorialDemo_v1_0.mov]]
 
−
*video tutorials have become a popular and widespread form to document GUI interactions, particularly tutorials
 
−
* they can have almost  the quality of direct tutoring
 
−
*they are compact in length and filesize (because the changes are local and small over time, MPEG compression is very effective with little quality loss), which makes them ideal for online distribution
 
−
*movie viewing capability is mainstream, i.e. all OS will have this capability, viewers can be downloaded for free
 
−
*the audio track can provide main instructions, motivation, commentary and an abundance of detail information at the right juncture, something very difficult to provide in other formats without overloading a tutorial
 
−
*the step by step interaction is captured unambiguously. We do not spend a lot of time and space in showing slides with screen captures.
 
−
*since they are easy to make and great software is inexpensive, potential use even for developer communication can be considered, e.g. to document complex bugs
 
−
*they have a low usage threshold, i.e. users are more inclined to watch a video than to dig through a power point presentation
 
−
*they are not all that useful for reference or main documentation material, e.g. a tutorial on main registration concepts is probably still better in PPT.
 
−
*formats: video files (quicktime, WMV, mp4 , Flash), optimized for streaming or download
 
  
 
== GUI Concepts & Development  ==
 
== GUI Concepts & Development  ==

Revision as of 15:21, 10 November 2009

Home < Projects:RegistrationDocumentation

Back to ARRA main page

Use Case Library

Reference Manual

  • Draft Registration Reference Manual, explaining all parameters in detail
  • This will contain detailed descriptions of each parameter and each control element within the slicer registration module. The description should help the user understand what exactly that function/parameter does and if/how useful it will be for their specific registration problem
  • Preferred formats: Slicer Wiki, maybe PDF

User Manuals & Tutorials

  • Video Tutorials: showcase of specific workflow
  • Background Tutorials, explaining the basics of registration, formats: PowerPoint. Minimal understanding of the inner workings of a registration optimization algorithm is essential to understand and judge the results obtained and obtainable.
  • this documentation will discussing the main registration module functionality as a whole, focusing not on the individual controls but the main workflow.

formats: Slicer Wiki, PowerPoint.


GUI Concepts & Development

Links

Bundled Registration and Tests

Retrieved from "https://www.na-mic.org/w/index.php?title=Projects:RegistrationDocumentation&oldid=44784"