1. Project management and documentation#

1.1 Documentation#

First class#

I really liked the way the course started, in fact we were able to get to know students from many other sections like computer sciences, biologists and people from the master’s program as well. We stood in a circle and had to introduce ourselves to the person in front of us, it was a very fun way to communicate with others. Then the course ended with a short visit of the fablab in form of a game. It was really fun.

Next courses#

In the next classes, we learned the objectives of the course. For instance, we learned how to compress an image, how to install a text editor. We also learned that documentation is very important to have a written record of our projects and to be able to share our experience with other people.

What to do ?#

I first started by installing a text editor, so I installed Visual Code Studio. You can also install another text editor if you like, it’s really up to you. VScodium is a community-driven, freely licensed binary distribution of Microsoft’s editor Visual Studio Code.

To be able to write on Visual Code Studio you have to learn how to write in Markdown, 👉Fabzero Tutorial 👈 You can follow this tutorial, it’s really easy to understand, so no worries. Don’t hesitate to check it out !

Images#

To modify the images, I installed GIMP. With the help of this application you can compress, resize, batch and crop your images. When you compress your images, you are also keeping the storage space low.

Here’s an example on how to compress an image :

So you have to click on IMAGE and then SCALE IMAGE. When you are done, you have to click on SCALE and your images will be compressed. It’s really not so complicated. You’ll get used to it.

Vector or Raster Image ?#

We also learned the difference between vector and raster images. The raster file format, along with vector, is one of the main two file types used for digital images.

Vector images are graphical representations of mathematical objects such as lines, curves, polygons, etc. These graphics are generated by computer, and they follow x and y-axis as their reference definition.

One of the strengths of raster images is the ability to capture detailed graphics and high-quality photographs taken from digital cameras.

How to set up and use Git on your computer ?#

1) Install and configure git#

For the next step, I had to install Git on my computer. I recommend you to use git because it’s efficient. It’s really easy and faster to use than GitLab GUI. You can work more efficiently with other people on a shared project at the same time. Maybe in the future I will use Git more often. This way we will waste less time on group projects and Time is money, right ? ⏳

  • To see if you already have Git on your computer, try to run this command in the terminal :

If you have installed Git, the output is going to be :

  • Once GIT is installed, you have to configure it. These are the steps that I followed.

What I got in the terminal :

2) SSH key#

SSH key is a cryptographic protocol, primarily used to enable secure access to remote servers and devices over the internet.

Downloading the SSH key was the most difficult part for me 🫠. But I changed my computer in the meantime, so I had to regenerate another ssh key, and doing it a second time wasn’t very complicated.

  • I first wrote ssh-keygen in the terminal.
  • Then I entered the file in which I wanted to save the key.
  • I also had to specify a passphrase. It’s just like a password.
  • I went to the repository indicated by the terminal.

This is what I got :

SSH key

After doing all these steps, I finally found my SSH key in my directory and it was there. I had a folder named .ssh, but the only problem was that I didn’t have the public key.

problem

With the help of some of my classmates, I realized that I had to display the file extensions and the hidden files to get the pub file.

hidden files

After that, the rest was no problem. For the last step, I only had to copy the key into my GitLab account.

3) Clone with SSH#

You can use Git to clone and work on a “working copy” of your remote project repository on your local computer. So, working on a local “working copy” allows you to make all the modification you need on a local version on your computer before you “commit” to the distant server.

clone via SSH cloning

Some important commands#

Command Meaning
git pull Download the latest changes in the project
git add -A Add all changes to commit
git commit -m “COMMENT TO DESCRIBE THE INTENTION OF THE COMMIT” Add all changes to commit
git push Send changes to remote server

Just a little reminder, don’t forget to use these commands whenever you modify your document.

Here you can see all the modifications that I made using these commands.

reminder

1.2 Project management#

To initiate the project effectively, we examined fundamental project management principles. Here are some techniques I applied for this particular project.

1.2.1 As-You-Work Documentation#

Starting the documentation process early and maintaining consistency is crucial for the project. Avoid waiting until the last minute to ensure thorough and effective documentation. Taking notes, photos, and videos regularly throughout the work session helps capture essential details.

1.2.2 Triage#

When working with limited time, prioritize crucial tasks first. For example, in building a robot, focus on key elements like the mechanical structure and internal electronics before non-essential details like the outer shell. This ensures you address the most important aspects and make progress on essential functionalities.

1.2.3 Modular & Hierarchical Planning#

Simplify your project by breaking it into smaller, prioritized components. Instead of approaching it as one big task, think of it as a combination of interconnected “Sub-Tasks.” Prioritize the components hierarchically