[REVIEW] 503 - Document High-Fidelity Prototype (#504)

* Criando branch para PR * Adicionando descrição inicial no readme * Adicionando a estrura inicial da documentação do prototipo * Adicionando tutorial de acesso ao prototipo * Iniciando tutorial de contribuição ao prototipo * Adicionando insumos para o tutorial de contribuição ao prototipo * Adiconando descrições em ingls * Corrigindo imagens * Corrigindo imagens quebrandas e texto faltante
memeLab · Oct 29, 2024 · f878ba7 · f878ba7
1 parent 489fd17
commit f878ba7
Show file tree

Hide file tree

Showing 10 changed files with 49 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -110,4 +110,8 @@ vim /etc/resolv.conf
 ```
 nameserver 172.21.176.1
 ```
-- Access the localhost using this IP (e.g.: 172.21.176.1:8000)
+- Access the localhost using this IP (e.g.: 172.21.176.1:8000)
+
+### Prototype
+
+The Jandig platform count with a High-Fidelity Prototype which aims the development and documentation of improvements related to usability. To acess and contribute with the prototype, follow the instructions in [Prototype Documentation](/docs/prototype.md).
diff --git a/docs/images/figma-home.png b/docs/images/figma-home.png
diff --git a/docs/images/figma-login.png b/docs/images/figma-login.png
diff --git a/docs/images/figma-save-local.PNG b/docs/images/figma-save-local.PNG
diff --git a/docs/images/figma-upload-file.png b/docs/images/figma-upload-file.png
diff --git a/docs/images/open-prototype.png b/docs/images/open-prototype.png
diff --git a/docs/images/project-figma.PNG b/docs/images/project-figma.PNG
diff --git a/docs/images/prototype-file-downhold.png b/docs/images/prototype-file-downhold.png
diff --git a/docs/images/save-file.PNG b/docs/images/save-file.PNG
diff --git a/docs/prototype.md b/docs/prototype.md
@@ -0,0 +1,44 @@
+# Prototype
+The Jandig platform prototype is a graphical representation of the platform developed using Figma [Figma](https://www.figma.com/downloads/) tool, it has the purpose of improving Jandig ARte platform's interface and user experience aspects. Thus, the High Fidelity Prototype is a representation of the platforms containing general usability improvements, used to arise activities to implement the suggested modifications.
+
+
+## Accessing the Prototype
+The prototype must be accessed using Figma platform, follow the steps below to access the prototype:
+
+1 - Login or Register on [Figma](https://www.figma.com/login) platform;
+
+![figma-login](./images/figma-save-local.PNG)
+
+2 - Download the [prototype file](https://github.com/memeLab/Jandig/blob/develop/docs/jandig_prototype.fig) to your computer;
+
+![prototype-file-downhold](./images/prototype-file-downhold.png)
+
+3 - Select the "import file" option on figma's main screen and select the previously downloaded file;
+
+![figma-home](./images/figma-home.png)
+
+![figma-upload-file](./images/figma-upload-file.png)
+
+5 - Access the prototype by clicking on the project.
+
+![open-prototype](./images/open-prototype.png)
+
+
+## Contributing to the Prototype
+
+1 - Access the prototype using Figma platform as written in the tutorial described in the previous section;
+
+2 - Open an Issue describing changes to be made to the prototype or select an existing issue and contribute to the issue. In order to do this follow the [contribution guide](https://github.com/memeLab/ARte/blob/master/.github/CONTRIBUTING.md);
+
+3 - After making changes to the prototype following the guidelines of the chosen or created issue, upload the file following the steps below:
+
+- 1 - Download the new version of the prototype onto your computer using your [Figma](https://www.figma.com/login);
+
+    ![project-figma](./images/project-figma.PNG)
+
+    ![figma-save-local](./images/figma-save-local.PNG)
+
+    ![save-file](./images/save-file.PNG)
+
+- 2 - Upload the file "jadig_prototype.fig" replacing the existing file with the updated version.
+