Tutorial Maker Tool
Description
The Tutorial Maker is a tool to automate the creation of tutorials within the 3D Slicer environment. To achieve this goal, a project management methodology has been implemented, combining weekly virtual meetings and using the GitHub platform as a code development and collaboration system version control.
This tool was developed by The 3D Slicer Latin America team, whose members have made significant progress in developing the Tutorial Maker Module, focusing on improving its functionality, usability, and accessibility.
Objectives
Among the objectives of the tutorial maker tool are the following:
- Internationalization: The strings of the module's user interface were marked, enabling easy translation into multiple languages. The module's installation steps in Spanish, Portuguese, and English are documented.
- Accessibility: A simplified installation and use of the module allows a broader range of users to benefit from the tool.
- Flexibility in Content Creation: The possibility to generate tutorials in multiple formats broadens the possibilities for distributing and utilizing the created content.
- Improved User Experience: Interface optimizations and new features make the process of creating tutorials more intuitive and efficient.
- Project Sustainability: Process automation and improved project management ensure the module's continuous development and long-term maintenance.
Features
Automated Tutorial Generation
Streamlines the creation of 3D Slicer tutorials by automatically running workflows and capturing screenshots for each step, reducing manual effort.
Integrated Annotation Tools
Includes a built-in editor to add arrows, text boxes, highlights, and other visual cues directly onto your tutorial screenshots to improve clarity.
Flexible Export Options
Allows users to save annotated screenshots and generate content suitable for various documentation formats (HTML, PDF, Markdown).
Multi-Language Support
Designed to facilitate the creation and localization of tutorials in multiple languages (including English, Spanish, and Portuguese), making Slicer accessible to a wider audience.
Repository
The Tutorial Maker tool repository contains a step-by-step installation process and is constantly updated according to the improvements introduced by the team.
First Evaluations
6 Zoom meetings have been held with collaborators of the 3D Slicer In My Language project (EOSS cycle 4) to evaluate the Tutorial Maker tool. During the meeting, team members from Senegal reported on the tests they conducted using the Tutorial Maker tool to create a French version of the Slicer4Minute tutorial using the latest version of 3D Slicer (3D Slicer 5.7 Preview Release). The first test was carried out in September and consisted of recreating the "FourMinTutorial".
Translated Materials
As part of the 3D Slicer for Latin America project, five tutorials were translated to Portuguese and two to Spanish. The tutorials are presented below.