The following guide details the wiki page and media requirements for submission to the Soft Robotics Toolkit. Links to previous submissions are also listed within the page as examples to guide wiki page creation.
The layout that is displayed in the example is an suggestion for how one might choose to represent their work. It is not a requirement to make a page layout identical to the example. The boxes with an X across the center within the following layouts, represent images.
Wiki Page Requirements
|
The main landing page of your wiki is the place to introduce the work contained within the rest of the documentation pages. This page should include project title, a summary of the project, images or videosof the device, and information about where the work was completed. This page can be used to introduce team members, include a reference to research lab(s) or describe the basis for the research. Images, videos, and other media (shown on the left with X boxes) should be included within text as visual aids as the project is introduced.
|
The background page of the wiki documentation set should include information on how the project was chosen, previous ideas, and any previous prototypes or ideas that were explored.
|
The design page should describe in summary how the device or component is constructed. Materials, geometry, and other design considerations that were made throughout the creation of the project should be listed here. Additional photos, illustrations and videos should also be included, especially if internal components or types of motion are described.
|
The fabrication page lays out the step-by-step, detailed instructions describing how the device was built. The purpose of this section is repeatability, users should be able to follow and recreate this tutorial on their own. A bill of materials should be included in this section as well allowing users to order the exact materials used.
For exmples of fabrication pages with the appropriate level of detail needed, look to the Fiber-reinforced or PneuNets tutorials for reference.
|
|
Lastly, the sidebar section of the wiki page is for your bibliography and to give credit to the individuals involved in the creation of the work or page. Please include the relevant citations that you are referencing or have published as well as all individuals involved in the creation of the project. Both citations and authors should be listed on the home page and will added to the designated sidebar upon publication by the editing staff.
Additionally, if your laboratory or research group has a logo, or if you would like to be known under a university or research group logo, this should also be uploaded to the home page to accompany the submission.
Media Recommendations
|
Images and videos of the work should be included throughout your wiki page to help users locate visual examples within the written tutorial. Images included in the wiki should be treated with the same consideration as the rest of the page, oftentimes drawing substantial attention as users scroll through the pages. Taking clear images and videos will give the page additional visual interest and help users navigate through sections.
The fabrication image (left) was used to accompany the section on the HPN Manipulator. The image displays a clean background, is in focus and shows clearly the placement of the tubing within an actuator.
|
|
Image and video documentation should be shot in a clean environment and on a background that does not distract from the object the image or video is displaying. Final images and videos should be in focus and edited if needed to reduce any unneeded space or extraneous footage.
The Soft Wheel Robot video (right) shows footage, illustrations and animations of testing, prototyping and final results within the video of the robot.
|
Illustrations are another useful media for conveying construction of the device and steps of fabrication. If it is difficult to show a step, an illustration can be considered. Adding callouts and arrows as well, can help create a more comprehensive image.
The illustration (left) was used to accompany an overview for the Fiber-Reinforced Actuator. Using a well laid out exploded view of the actuator with clear call outs gives users a more complete picture of the complex construction technique.