mirror of
https://github.com/kylelobo/The-Documentation-Compendium.git
synced 2025-09-03 01:52:42 +02:00
Merge pull request #26 from carloswhite/patch-2
Translate 'Hackathon.md'
This commit is contained in:
@@ -0,0 +1,109 @@
|
||||
<p align="center">
|
||||
<a href="" rel="noopener">
|
||||
<img src="https://i.imgur.com/AZ2iWek.png" alt="Project logo"></a>
|
||||
</p>
|
||||
<h3 align="center">Título do Projeto</h3>
|
||||
|
||||
<div align="center">
|
||||
|
||||
[](http://hackathon.url.com)
|
||||
[]()
|
||||
[](https://github.com/kylelobo/The-Documentation-Compendium/issues)
|
||||
[](https://github.com/kylelobo/The-Documentation-Compendium/pulls)
|
||||
[](LICENSE.md)
|
||||
|
||||
</div>
|
||||
|
||||
---
|
||||
|
||||
<p align="center"> Descreva o seu projeto em algumas linhas.
|
||||
<br>
|
||||
</p>
|
||||
|
||||
## 📝 Índice
|
||||
- [Declaração do Problema](#declaração_problema)
|
||||
- [Ideia / Solução](#ideia)
|
||||
- [Dependências / Limitaçōes](#limitacoes)
|
||||
- [Planos Futuros](#planos_futuros)
|
||||
- [Começando](#comecando)
|
||||
- [Uso](#uso)
|
||||
- [Feito Com](#feito_com)
|
||||
- [Contribuição](../CONTRIBUTING.md)
|
||||
- [Autores](#autores)
|
||||
- [Agradecimentos](#agradecimentos)
|
||||
|
||||
## 🧐 Declaração do Problema <a name = "declaração_problema"></a>
|
||||
Ê importante desenvolver e seguir um formato específico quando se está escrevendo a declaração do problema. Existem várias maneiras de se fazer isso, porém este template à seguir foca em definir o problema de maneira eficaz usando a filosofía de análise de negócios.
|
||||
|
||||
- IDEAL: Essa parte é usada para descrever o estado no qual o produto estará ao fim do desenvolvimento, baseado no desejo de seus desenvolvedores. É aqui que você deve ilustrar o que esperar do produto uma vez que ele esteja pronto.
|
||||
|
||||
- REALIDADE: Essa parte é usada para descrever o atual estado no processo de produção do produto.
|
||||
|
||||
- CONSEQUÊNCIAS: Essa parte é usada para descrever os impactos caso o problema nāo seja resolvido, ou melhorias não sejam atingidas. Isso inclui custos associados com a perca de dinheiro, tempo, produtividade, competividade, e etc.
|
||||
|
||||
Usar este formato resultará em um documento que pde ser usado para entender o problema em questão e gerará os requerimentos para um solucão eficaz.
|
||||
|
||||
## 💡 Ideia / Solução <a name = "ideia"></a>
|
||||
Já nessa parte, o objetivo é descrever potenciais soluçōes.
|
||||
|
||||
Uma vez que os campos ideal, realidade, e as consequências estejam completos, se torna fácil prover uma soluçāo para um determinado problema.
|
||||
|
||||
## ⛓️ Dependências / Limitaçōes <a name = "limitacoes"></a>
|
||||
- Quais são as dependências de seu projeto?
|
||||
|
||||
- Descreva cada limitação em detalhes mas com termos concisos
|
||||
|
||||
- Explique o porquê de cada limitação
|
||||
|
||||
- Dê a razão pela qual uma determinada limitação não pôde ser resolvida usando os metodos que você descreveu acima
|
||||
|
||||
- Faça uma análise de cada limitação com relação às conclusoōes de seu trabalho e/ou projeto, e, se apropriado, descreva como tais limitaçōes possam beneficiar-se de uma pesquisa mais detalhada.
|
||||
|
||||
## 🚀 Planos Futuros <a name = "planos_futuros"></a>
|
||||
Escreva sobre as coisas que você não pôde desenvolver durante esta Hackathon; e sobre o quê seu projeto pode atingir no futuro.
|
||||
|
||||
## 🏁 Começando <a name = "comecando"></a>
|
||||
Estas intruçōes te darão uma cópia funcional do projeto na sua máquina local para desenvolvimento e testes. Veja [deployment](#deployment) para uma descrição de como realizar o deployment deste projeto online.
|
||||
|
||||
### Pré-requisitos
|
||||
|
||||
Descreva o que é necessário para instalar este software e como instalá-lo.
|
||||
|
||||
```
|
||||
Dê exemplos
|
||||
```
|
||||
|
||||
### Instalação
|
||||
|
||||
Passo-a-passo com exemplos que reproduzam um estágio de desenvolvimento funcional.
|
||||
|
||||
Descreva o passo a ser tomado
|
||||
|
||||
```
|
||||
Dê um exemplo
|
||||
```
|
||||
|
||||
Repita
|
||||
|
||||
```
|
||||
Até terminar
|
||||
```
|
||||
|
||||
## 🎈 Uso <a name="uso"></a>
|
||||
Descreva como utilizar seu app ou sistema.
|
||||
|
||||
## ⛏️ Feito Com <a name = "feito_com"></a>
|
||||
- [MongoDB](https://www.mongodb.com/) - Database
|
||||
- [Express](https://expressjs.com/) - Server Framework
|
||||
- [VueJs](https://vuejs.org/) - Web Framework
|
||||
- [NodeJs](https://nodejs.org/en/) - Server Environment
|
||||
|
||||
## ✍️ Autores <a name = "autores"></a>
|
||||
- [@kylelobo](https://github.com/kylelobo) - Ideia & Trabalho inicial
|
||||
|
||||
Confira também a lista de [contribuidores](https://github.com/kylelobo/The-Documentation-Compendium/contributors) que participaram nesse projeto.
|
||||
|
||||
## 🎉 Agradecimentos <a name = "agradecimentos"></a>
|
||||
+ Agradecimentos a terceiros, autores ou não de código utilizado nesse projeto.
|
||||
+ Inpiraçōes
|
||||
+ Referêcias
|
||||
|
Reference in New Issue
Block a user