1. State of the art, project management and documentation¶
Why is it important to document and share information?¶
How Collaboration Makes us Better Designers?
For starters, there is no such thing as a solitary creative person, because we seek inspiration out of everything unconsciously or consciously, we ask others if they like our designs, we use people as our canvas, we compare our work, it is inevitable… We often assume that the problems we face are unique, that it is only happening to us, but surprise, they might me another person across the world that has the same situation and like you, doesn’t know how to solve it .. So why not help each other to be better designers by sharing our knowledge?
This term stands for anything that anyone can use, download, modify, share, it is basically public access without any locks. The concept was first used only to software's, but nowadays it can apply to a variety of things, like products, programs, files, etc.
References & Inspiration¶
I founded beautiful the page of Raúl Babines, I think he was really inspired when he designed it, also, I wanted a darker background rather than a clear one, mainly because I found interesting the contrast with light colors, so i took his page as a reference. | I also discovered the page of Jeanne Rochedieu Neboit, she built her hole documentation with MkDocs and BOOTSTRA.386., I really liked her page, it gave me an idea of how far we can take de coding and modify our platforms. |
---|---|
Tools¶
Documentation workflow¶
Mattermost¶
Mattermost will be the principal via of communication. It already has a different chat for each week; you can discus,share information and ask questions.
Gitlab¶
Gitlab will be the platform in which we upload all our information as a repository, in this platform I will upload all my assignments, documenting the process and workflow of the skills caption and the final project. This site uses Markdown language, which is basically a simpler version of html. Before doing anything, I watched a youtube tutorial of how to get a Gitlab page started from scratch to understand most of what the template already had and what all of that was for. So, to make it look more like mine, I selected “mkdocs.yml”, there is where we can make the changes in the theme.
You can also visualize what your codes in Mkdown looks like in the actual page using “Preview to the Side”, its doesn’t have 100% accuracy but it will help to have a better idea of what we are doing before committing.
To upload the information:
Elements¶
Images¶
Using images can be a great complement to our documentation, because it will allow us to show things that can't be really explain in text or are meant to be seen.
The first thing is uploading the images to GitLab:
Disclaimer: The website has a size capacity of 500MG, so, to be able to upload images without worrying about exceeding that limit, it will be needed to reduce the size of them; to do so you can use the platform of Tiny PNG.
{ width=number align=center/right/left }
Images size in Canva¶
To edit the pictures for the process and for the collages I used Canva, because it is a very easy platform to work in, and so, using Canva Pro I was able to customize all the specifics to download, like the dimensions, the file size, remove the background and to compress them. Doing this I save the step of having to compress the images thought TinyPNG.
Links¶
<a href="LINK">Write the name of the link</a>
Syntax¶
To get a little bit more familiar with the syntax, I watched another youtube tutorial, it was useful to me to understand how to do thigs like: charts, use italics, bold, etc.
Table of content¶
|Title 1|Title 2|Title 3|
|--|--|--|
|Content 1| Contect 2| Content 3|
Videos¶
Added Codes¶
Sticky tabs¶
navigation.tabs.sticky
Back to top buttom¶
navigation.top
Copy codes¶
content.code.copy