1. State of the art, project management and documentation¶
Research & Ideation¶
I’m taking the Fabricademy course as a single node, which means I usually work from my own Fab Lab with support from a remote instructor, completing weekly assignments. However, for a certain period, actually attending classes at a Fabricademy node with other participants is stimulating and offers valuable hands-on experiences. Because of this, I arranged to spend one month at Fab Lab Barcelona to participate in person.
・Review the class archive to check which tools can be used for each ocation in order to make own documentation.
・Think how to do make a structure of the page.
References & Inspiration¶
Participating in Fab Conferences and Feature Fabrics Mexico has been the inspiration for me to take the Fabricademy course. From the lessons, I could get the echnics how to make my documentation.
Documentation workflow¶
From here on, I’ll be sharing the process of creating weekly documentation.
Preparation¶
Preparation1 Download the GIMP
From that link, download the GIMP to resize and optimise the images.
Preparation 2 Resize the images
At GIMP, "open" the image file(1), from the "Select" tab (2), select and clic the "Scale image" (3).
-Put the number of size and piexels for which I want to do change.
Recommended size (width)= 800-1000 (4) Recommended pixel=72 (5)
-Click the bottum of "Scale" (6).
-Then export to save the chaned sized image (7).
Process¶
Step 1
Open my documentation page. Do click the gitlab mark on the right top of the page (1) When you can do click it, you can enter the gitlab page and find "edit"(2). Click this mark the "Web IDE" (3), jump to the gitlab page where I can make documentation. If "edit" tab dosen`t be appeared, it's necessary to log in.
Step 2
First of all, I the page color can be changed from mkdocs (2). NOt only the color change but also other items can be arranged here.
Step 3 Upload
Upload the images (3). When you can find "image" tab and click there, just on the "image" tab, the pulldown is come out and choose the "upload" and ther the photos can be upload to the gitlab.
I write down the text about what I did. When somthing to chage is happening, you can find (4) the mark and numer mentioned. This number means that the number of points where something change is happening".
When the changing is finished, click on for the updating. When the updating is finished, the notice is come out when Upload the images which I would like to add on my page.
Another tips for making documentation.¶
-CANVA
-Make a collage with Canva
-VIMEO
-Upload the Vimeo Can be upload the video and embed the link of the page.
-REMOVE
Remove the backgroud of the image at Remove
-REVIEW
-When you can click (←), the review site can be allined. So you can chen the page making the documentation.
A:you can write down the text, put into the images and link.
B: at the same time you can review the page adter undated.
Tools¶
- [GIMP](https://www.gimp.org/)
- [Canva](https://www.canva.com/)
- [Markdown](https://en.wikipedia.org/wiki/Markdown)
- [MkDocs](https://xxx)
- [Material theme](https://xxx)