In this course Fabricademy uses [the open source online platform GitLab](https://gitlab.com) for the documenting and sharing of projects. A password will be provided for you by the Fabricademy ICT people. You can then login and start documenting. When you login, you find a directory. Under 'docs' you will find a folder with all the assignments. Under 'images' you can upload photos, pdfs and (zip)files (right-click on an uploaded image, copy the image location and paste this in your documentation). Under 'projects' you can log your final project. When you start an assignment, the content management system (CMS) will first lead you to the 'consumer's' interface, in which you see more or less what you get. It is better to go to the 'nerd's' interface (hit the 'WEB IDE' button). which is in code, because this works faster. For the WEB IDE you need a special sign-in, which will also be provided for you by the Fabricademy ICT people. You need to learn some basic code in order to use the WEB IDE CMS. You can find all the necessary commands in [the online GitLab repository and archive](https://gitlab.com/gitlab-org) and in [the online GitLab manual for the basics](https://docs.gitlab.com/ee/gitlab-basics/). You can also find tutorials if you Google them. It is pretty straightforward. One tip: when you upload (zip)files in the images folder and you want to have them downloadable in your documentation, you need to insert the 'download url', which you get by hitting the 'downlad button' on the right (cloud with an arrow) and then copying the url from your browser.
In this course Fabricademy uses [the open source online platform GitLab](https://gitlab.com) for the documenting and sharing of projects. A password will be provided for you by the Fabricademy ICT people. You can then login and start documenting. When you login, you find a directory. Under 'docs' you will find a folder with all the assignments. Under 'images' you can upload photos, pdfs and (zip)files (right-click on an uploaded image, copy the image location and paste this in your documentation). Under 'projects' you can log your final project. When you start an assignment, the content management system (CMS) will first lead you to the 'consumer's' interface, in which you more or less see what you get. It is better to go to the 'nerd's' interface (hit the 'WEB IDE' button) which is in code. This works faster. For the WEB IDE you need a special sign-in, which will also be provided for you by the Fabricademy ICT people. You need to learn some basic code in order to use the WEB IDE CMS. You can find all the necessary commands in [the online GitLab repository and archive](https://gitlab.com/gitlab-org) and in [the online GitLab manual for the basics](https://docs.gitlab.com/ee/gitlab-basics/). You can also find tutorials if you Google them. It is pretty straightforward. Two tips. Because uploading images can take forever (it can fill your whole morning), be sure to compile and edit your images beforehand (make collages) and reduce the image-size to below 500 kb. When you upload (zip)files in the images folder and you want to have them downloadable in your documentation, you need to insert the 'download url', which you get by hitting the 'downlad button' on the right (cloud with an arrow) and then copying the url from your browser.
It seems like a hassle and in fact, it _is_ a hassle. But documenting helps you in two important ways. First it helps you to think better about your assignments because you need to be able to explain them to another person. This helps you to better understand for yourself what what you are working on and why. Second it helps you with remembering what you've learned. It is easier to learn new skills and techniques, and to actually 'acquire' the knowlegde, when you document what you have done. And surely, your information might also help others who are working on the same thing, like your fellow Fabricademy students.
It seems like a hassle and in fact, it _is_ a hassle. But documenting helps you in two important ways. First it helps you to think better about your assignments because you need to be able to explain them to another person. This helps you to better understand for yourself what what you are working on and why. Second it helps you to remember what you've learned. It is easier to learn new skills and techniques, and to actually 'acquire' the knowlegde when you document what you have done. And surely, your information might also help others who are working on the same thing, like your fellow Fabricademy students.
_Documenting takes time and effort but it is fun too. You can make a pretty showcase for your work._
_Documenting takes time and effort but it is fun too. You can make a nice showcase for your work._
## Telling a Story
Documenting online is different from keeping notes in a paper diary. GitLab is a public space and everybody can see what you have uploaded. To do them (and yourself) a favor, you need to develop some storytelling skills. Sorry to break this news to you. But by bad or sloppy storytelling people will find your documenting boring and unimportant and also you will leave a none-too-professional impression, which is unjustified because you ARE a Fabricademy talent who is doing great work. So training yourself in better storytelling will do better justice to your talents and designs. Which, by the way, will also greatly improve your design efforts as well. Because good design is first and foremost a good story. How do you tell a good story? Be as specific and as personal as you can. Try to think of the reader as a good but critical friend you are talking to. Do not focus only on the how but also on the why - why do you think someting is interesting and important? Think of your documenting as a food blog: nobody wants to read just a list of ingredients and the recipe. People want to see the scrumptious meal, with tips about how and when to serve it, with some personal words from the cook and how her kids thought the recipe was yummy. Give examples from your own life. Be sure to upload nice images that show what you are writing about. Make jokes. Be light-hearted. And don't worry about your English. There is always the spelling corrector and Googe Translate! As an example of storytelling, and also to practice my GitLab content management system-skills, I have done some documentating below about quilts.
Documenting online is different from keeping notes in a paper diary. GitLab is a public space and everybody can see what you have uploaded. To do them (and yourself) a favor, you need to develop some storytelling skills. Sorry to break this news to you. But by bad or sloppy storytelling people will find your documenting boring and unimportant and also you will leave a none-too-professional impression, which is unjustified because you ARE a Fabricademy talent who is doing great work. So training yourself in better storytelling will do better justice to your talents and designs. Which, by the way, will also greatly improve your design efforts as well. Because good design is first and foremost a good story. How do you tell a good story? Be as specific and as personal as you can. Try to think of the reader as a good but critical friend you are talking to. Do not focus only on the how but also on the why - why do you think someting is interesting and important? Think of your documenting as a food blog: nobody wants to read just a list of ingredients and the recipe. People want to see the scrumptious meal, with tips about how and when to serve it, with some personal words from the cook and how her kids thought the recipe was yummy. Give examples from your own life. Be sure to upload nice images that show what you are writing about. Put effort into making intriguing titles and headings. Make jokes. Be light-hearted. And don't worry about your English. There is always the spelling corrector and Googe Translate! As an example of storytelling, and also to practice my GitLab content management system-skills, I have done some documenting below about quilts.
