Documentation requirements
During the duration of the program participants are required to document their progress and perspective, customising their website, to both create a space that is entirely theirs and from which they can be evaluated to graduate and receive the diploma when successfully completing the weeks and final project work. When documenting, participants are required to follow parameters that ensure longevity of documentation so that participants can learn from one another.
Hosting of documentation - required parameters and best practices
All produced content must be hosted on the fabcloud repositories, following the standards presented in this guide. Other forms of additional material are welcomed, but only as additional material to enrich the work of documentation.
-
General documentation text must be in markdown, as presented in the rest of this guide
-
Code for electronics and scripts must be included in the form of markdown and not visual aids such as images
-
Visual materials such as images and gifs - must be uploaded in fabcloud and optimised following the standards described here
-
Audio material must be formatted, optimised and included in markdown via fabcloud, as explained here. Other examples of how this feature can be used are available in previous participants' documentations.
-
Video material must be optimised and preferably uploaded to the fabcloud directly as small videos. See how here. Longer videos can be placed on external platforms such as Youtube / Vimeo if larger than 10MB, after optimisation, see how to embed those here.
-
2D Vectorial fabrication files (DXF, PDF, SVG, EPS) must be included in markdown and uploaded in fabcloud following the guidelines provided here
-
3D Models larger than 10MB (and any fabrication file larger than 10MB) can be uploaded zipped into the fabcloud and visualised on the git webpage by uploading it on external platforms (such as thingiverse, fab.com / p3d.in / cults3d.com ) and embedded on the page.
-
Embedding of external visual material such as Google slides, miro or canva iframes and other forms of embedded content is not eligible as the main documentation. Each visual slide can be exported and included as an optimised image, text must remain available as plain markdown text alongside the visual material. Optimised presentations and slides can be uploaded in fabcloud as a zipped PDF and linked as a file in the documentation. Final presentation slides will follow a different procedure