mirror of
https://github.com/kylelobo/The-Documentation-Compendium.git
synced 2025-09-03 01:52:42 +02:00
translated hackathon and fixed minimal
This commit is contained in:
Alberto Mosconi
@@ -0,0 +1,116 @@
|
||||
<p align="center">
|
||||
<a href="" rel="noopener">
|
||||
<img src="https://i.imgur.com/AZ2iWek.png" alt="Project logo"></a>
|
||||
</p>
|
||||
<h3 align="center">Titolo del Progetto</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"> Poche righe di descrizione del tuo progetto.
|
||||
<br>
|
||||
</p>
|
||||
|
||||
## 📝 Indice
|
||||
|
||||
- [Testo del Problema](#problem_statement)
|
||||
- [Idea / Soluzione](#idea)
|
||||
- [Dipendenze / Limitazioni](#limitations)
|
||||
- [Scopo Futuro](#future_scope)
|
||||
- [Impostare un ambiente locale](#getting_started)
|
||||
- [Utilizzo](#usage)
|
||||
- [Tecnologie Utilizzate](#tech_stack)
|
||||
- [Contribuire](../CONTRIBUTING.md)
|
||||
- [Autori](#authors)
|
||||
- [Riconoscimenti](#acknowledgments)
|
||||
|
||||
## 🧐 Testo del Problema <a name = "problem_statement"></a>
|
||||
|
||||
È utile progettare e seguire un format specifico quando si scrive il testo di un problema. Sebbene ci siano diverse opzioni per far ciò, quanto segue è un semplice e diretto modello spesso usato in Analisi Aziendale per mantenere il focus sulla definizione del problema.
|
||||
|
||||
- IDEALE: Questa sezione è utilizzata per descrivere lo stato finale del processo o prodotto. Alla larga, questa sezione
|
||||
dovrebbe illustrare come l'ambiente si presenterà una volta implementata la soluzione.
|
||||
- REALTÀ: Questa sezione serve a descrivere lo stato corrente del processo o prodotto.
|
||||
- CONSEGUENZE: Questa sezione è utilizzata per descrivere le conseguenze sull'azienda se il problema non è risolto o migliorato.
|
||||
Questo include costi associati con la perdita di soldi, tempo, produttività, vantaggi competitivi, e così via.
|
||||
|
||||
Seguire questo format risulterà in un documento che può essere utilizzato per capire il problema e suscitare requisiti che porteranno ad una soluzione vincente.
|
||||
|
||||
## 💡 Idea / Soluzione <a name = "idea"></a>
|
||||
|
||||
Questa sezione è utilizzata per descrivere potenziali soluzioni.
|
||||
|
||||
Una volta che le sezioni ideale, realtà e conseguenze sono state completate, e capite, diventa facile fornire una soluzione al problema.
|
||||
|
||||
## ⛓️ Dipendenze / Limitazioni <a name = "limitations"></a>
|
||||
|
||||
- Quali sono le dipendenze del tuo progetto?
|
||||
- Descrivi ogni limitazione in termini dettagliati ma concisi
|
||||
- Spiega il motivo dell'esistenza di ogni limitazione
|
||||
- Fornisci le ragioni per cui ogni limitazione non poteva essere superata con il metodo scelto.
|
||||
- Valuta l'impatto di ogni limitazione in relazione ai ritrovamenti e conclusioni del tuo progetto, e se adeguato, descrivi come queste limitazioni potrebbero indicare al bisogno di ricerche ulteriori.
|
||||
|
||||
## 🚀 Scopo Futuro <a name = "future_scope"></a>
|
||||
|
||||
Scrivi riguardo a ciò che non sei riuscito a sviluppare durante il corso della Hackathon; e riguardo a quello che il tuo progetto può ottenere in futuro.
|
||||
|
||||
## 🏁 Come Iniziare <a name = "getting_started"></a>
|
||||
|
||||
Queste istruzioni ti daranno una copia del progetto funzionante sul tuo computer locale per scopi di sviluppo e testing. Vedi [deployment](#deployment) per istruzioni su come deployare il progetto.
|
||||
|
||||
### Prerequisiti
|
||||
|
||||
Di cosa hai bisogno per installare il software e come installarle.
|
||||
|
||||
```
|
||||
Dai esempi
|
||||
```
|
||||
|
||||
### Installazione
|
||||
|
||||
Una serie di esempi passo a passo che ti dicono come avviare un ambiente di sviluppo.
|
||||
|
||||
Indica qual è il passo
|
||||
|
||||
```
|
||||
Dai l'esempio
|
||||
```
|
||||
|
||||
E ripeti
|
||||
|
||||
```
|
||||
Fino alla fine
|
||||
```
|
||||
|
||||
## 🎈 Utilizzo <a name="usage"></a>
|
||||
|
||||
Aggiungi note su come usare il sistema.
|
||||
|
||||
## ⛏️ Costruito con <a name = "tech_stack"></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
|
||||
|
||||
## ✍️ Autori <a name = "authors"></a>
|
||||
|
||||
- [@kylelobo](https://github.com/kylelobo) - Idea & Lavoro iniziare
|
||||
|
||||
Vedi anche la lista di [contributori](https://github.com/kylelobo/The-Documentation-Compendium/contributors)
|
||||
che hanno partecipato a questo progetto.
|
||||
|
||||
## 🎉 Riconoscimenti <a name = "acknowledgments"></a>
|
||||
|
||||
- Cenno a tutti quelli il cui codice è stato utilizzato
|
||||
- Ispirazione
|
||||
- Riferimenti
|
||||
|
||||
@@ -11,7 +11,7 @@
|
||||
|
||||
Scrivi circa 1-2 paragrafi descrivendo lo scopo del tuo progetto.
|
||||
|
||||
## Getting Started <a name = "getting_started"></a>
|
||||
## Come Iniziare <a name = "getting_started"></a>
|
||||
|
||||
Queste istruzioni ti daranno una copia del progetto funzionante sul tuo computer locale per scopi di sviluppo e testing. Vedi [deployment](#deployment) per istruzioni su come deployare il progetto.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user