1. State of the art, project management and documentation¶

Portada

The Importance of Documenting¶

Documentation is a fundamental tool in any field, whether personal, academic, professional, or business-related. Its importance lies in the fact that it allows us to record, organize, and preserve valuable information for future reference. Below are some key reasons why documentation is essential:

Preserving knowledge: Documentation ensures that knowledge and information are not lost over time. By recording processes, decisions, learnings, and results, it facilitates the transmission of that knowledge to others and future generations, preventing the loss of valuable information.

Facilitating decision-making: Having access to well-documented information allows for informed decision-making based on facts. In both work and academic settings, clear and precise documentation contributes to more effective decision-making and fewer errors.

Increasing efficiency and productivity: When documentation describes procedures, methodologies, and best practices, it reduces errors and the need to repeat tasks. This also optimizes time, as people can quickly refer to existing documents instead of recreating information.

The tools¶

To make this whole experience work we will use 3 key tools. And i used this tutorial to understand how to use each one

GITLAB PLATFORM - To the repository

NUEVAL - To the evaluation local and global

MATTERMOST - To communicate

describe what you see in this image

Hola Mundo y todos los que lo habitan "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum."

weekly assignment

Check out the weekly assignment here or login to your NuEval progress and evaluation page.

about your images..delete the tip!!

Remember to credit/reference all your images to their authors. Open source helps us create change faster together, but we all deserve recognition for what we make, design, think, develop.
remember to resize and optimize all your images. You will run out of space and the more data, the more servers, the more cooling systems and energy wasted :) make a choice at every image :)

This image is optimised in size with resolution 72 and passed through tinypng for final optimisation. Remove tips when you don't need them anymore!

get inspired!!!

Check out and research alumni pages to betetr understand how to document and get inspired

Hacking the documentation font & graphics - Stephanie Vilayphiou - GreenLab
Designed graphical theme & weekly icons - Barbara Rakovska - FabLab Bcn
Audio introduction - Sara Alvarez TextileLab Amsterdam
Designed graphical theme - Olatz Pereda - BDC

Add your fav alumni's pages as references

References & Inspiration¶

"Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum."

Two images side-by-side

describe what you see in this image

Image reference

Download reference

Links to reference files, PDF, booklets,

about your images..delete the tip!!

Remember to credit/reference all your images to their authors. Open source helps us create change faster together, but we all deserve recognition for what we make, design, think, develop.
remember to resize and optimize all your images. You will run out of space and the more data, the more servers, the more cooling systems and energy wasted :) make a choice at every image :)

This image is optimised in size with resolution 72 and passed through tinypng for final optimisation. Remove tips when you don't need them anymore!

Tools¶

Documentation workflow¶