-
Notifications
You must be signed in to change notification settings - Fork 130
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Luana.melo #108
base: master
Are you sure you want to change the base?
Luana.melo #108
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,76 @@ | ||
+++ | ||
title = "Documentação OpenDev" | ||
date = 2021-04-17 | ||
tags = [] | ||
categories = [] | ||
+++ | ||
|
||
|
||
# Autores | ||
|
||
Este documento foi produzido por Luana Barbosa de Melo. | ||
|
||
- Matrícula: 117210906 | ||
- Contato: [email protected] | ||
- Projeto documentado: https://github.com/OpenDevUFCG | ||
|
||
# Descrição Arquitetural -- Comunidade voltada a incentivar a cultura open source no curso de Ciência da Computação da UFCG | ||
|
||
Este documento descreve parte da arquitetura do projeto [OpenDev](https://github.com/OpenDevUFCG). Essa descrição foi baseada principalmente no modelo [C4](https://c4model.com/). | ||
|
||
|
||
## Descrição Geral sobre o OpenDev | ||
|
||
<<<<<<< HEAD | ||
O Open Dev é um projeto que tem como objetivo "incentivar a cultura open source" principalmente no curso de Ciencia da Computação da UFCG, reunindo varios projetos open source, na sua plataforma. | ||
|
||
Como os mesmos se apresentam, eles estão desenvolvendo para a UFCG, para os estudantes, e pra você interessado a aprender e a contribuir. | ||
|
||
|
||
### Objetivo Geral | ||
|
||
Open Source permite que qualquer pessoa possa ver, modificar, contribuir e distribuir seu código. No entanto, como um sistema que traz esse ideal, é uma plataforma de código aberto, para contribuir e entregar conteúdo, sendo assim ajuda mútua. Além de um site de apresentação de todo o projeto. | ||
|
||
### Objetivos Específicos | ||
|
||
Implementar um serviço para reunir todos, ou quase todos projetos opensource que carreguem os mesmos objetivos que eles. Esses são: Estimular a troca de conhecimento entre os estudantes, incentivar a criação de mais projetos opensource, quebrar o gelo da primeira contribuição em algum projeto e por fim, desenvolver projetos para os estudantes. | ||
Além de desenvolverem projetos dentro dessa comunidade para ajuda de estudantes, principalmente da UFCG. "Queremos ser a comunidade que possa encorajar pessoas a tomarem o primeiro passo, a sugerir novas ideias e principalmente, a contruí-las". Para mais detalhes sobre o projeto abordado, acesse [este link](https://opendevufcg.org/). | ||
|
||
|
||
### Contexto | ||
|
||
O contexto do Open Dev é bem simples, é uma base/estrutura que reune atualmente 14 novos projetos com a mesma iniciativa que ele , e que através da sua plataforma podemos ter acesso a esses projetos e suas funcionalidades. | ||
|
||
![fig1](diagramaContexto.png) | ||
|
||
|
||
### Containers | ||
|
||
Como containers do OpenDev, podemos elencar 1 entidade: Web Page. | ||
|
||
**Web Page**, é responsável por pela representação gráfica do sistema, ou seja, todo o HTML que o browser irá interpretar e renderizar para o usuário final. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Só há um container nesse sistema? Usuário não é container, não deve estar nesse diagrama. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Você incluiu o sistema no diagrama de container. |
||
|
||
|
||
![fig2](diagramaContainers.png) | ||
|
||
### Componentes | ||
|
||
O componente Pages que usa JavaScrip, HTML e CSS, para fornecer visualização interativa com dados. É nesse componente, encontra-se todas as subaplicações disponibilizadas pelo OpenDev. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Sistema no diagrama de componentes? Onde está o detalhamento do container. Ele aparece aqui de novo. Não deve aparecer. |
||
|
||
![fig3](diagramaComponentes.png) | ||
|
||
### Código | ||
|
||
<pre> | ||
Nesta etapa não faremos diagramas que apresentam detalhes da | ||
implementação. Faremos isso mais adiante. | ||
</pre> | ||
|
||
### Visão de Informação | ||
|
||
Página Web com redirecionamento para outras páginas web ou projetos no github | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Não há o que corrigir aqui. Muito superficial. |
||
|
||
![fig4](diagramaInformativo.png) | ||
======= | ||
O Open Dev é um projeto que tem como objetivo "incentivar a cultura open source" principalmente no curso de Ciencia da Computação da UFCG, reunindo varios projetos open source. | ||
>>>>>>> 1b6c42a0e5d62dd3bb93c3056266de5c9653c79c |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Há problemas também na notação. No diagrama de contexto apenas colocamos em alto nível o sistema e os agentes externos que se comunicam com ele. O que significa o losango no arco entre o sistema e projetos? O que significa "funcionalidades do projeto". Esse diagrama não segue de forma alguma as diretrizes do modelo c4.