Documentazione Drone Sky Check¶
Questa documentazione aiuta a conoscere e usare Drone Sky Check, con una sezione orientata agli utenti finali e una sezione tecnica dedicata a chi mantiene o integra il progetto.
Come Usare Questa Documentazione¶
La documentazione e' pensata per crescere in modo ordinato.
Per un primo orientamento, leggere:
Accesso Al Servizio¶
Il sito ufficiale pubblico di Drone Sky Check e':
Dal sito ufficiale si accede alla web application operativa, cioe' alla mappa principale:
Per iniziare dalla prospettiva dell'utilizzatore, partire da Documentazione utente e seguire la struttura dell'applicazione:
| Sezione | Documento principale | Cosa contiene |
|---|---|---|
| Overview | User Overview | Organizzazione generale dell'interfaccia e workflow principali. |
| Dashboard | Dashboard | Schermata principale, barra superiore, pulsanti e indicatori. |
| Mappa | Mappa | Navigazione, selezione, popup, pannello informazioni, legenda e mappe di sfondo. |
| Layer | Layer | Informazioni che si accendono o spengono sulla mappa. |
| Strumenti | Strumenti | Funzioni del menu Tools che richiedono azioni sulla mappa. |
| Settings | docs/user/settings.md |
Pagina pianificata. |
| FAQ | docs/user/faq.md |
Pagina pianificata. |
| Troubleshooting | docs/user/troubleshooting.md |
Pagina pianificata. |
Per capire le regole editoriali e di manutenzione, leggere:
Le pagine utente descriveranno cosa vede e cosa puo' fare l'operatore. Le pagine developer descriveranno architettura, backend, frontend, dati, API e regole di sviluppo.
Organizzazione¶
La documentazione sara' organizzata in tre aree principali:
| Area | Scopo |
|---|---|
| Product | Spiega cos'e' Drone Sky Check, quale problema risolve e quali principi guidano il progetto. |
| User Documentation | Descrive funzionalita', workflow e strumenti dal punto di vista dell'utilizzatore. |
| Developer Documentation | Descrive architettura, dati, API, integrazioni e manutenzione tecnica. |
Struttura Della Documentazione Utente¶
La documentazione utente segue l'organizzazione reale dell'interfaccia. Le pagine introduttive spiegano la struttura generale, mentre le pagine di dettaglio sono collocate sotto Layer o Strumenti in base al comportamento nell'applicazione.
Layer¶
I layer sono informazioni visualizzate sulla mappa. Possono essere attivati o disattivati dal pannello Selezione zone o dai controlli rapidi laterali.
Le mappe di sfondo Satellite e Topo fanno parte della pagina Mappa e non sono previste come documenti separati.
| Layer | Documento | Stato | Note di roadmap |
|---|---|---|---|
| Introduzione ai layer | Layer | Complete | Pagina guida per distinguere layer e strumenti. |
| Zone di volo | Zone di volo | Complete | Copre quote, colori, badge e lettura delle zone. |
| NOTAM | NOTAM | Complete | Pagina dedicata per aree temporanee e informazioni collegate. |
| Infrastrutture aeronautiche | Infrastrutture aeronautiche | Complete | Copre aeroporti, aviosuperfici, eliporti e idrosuperfici. |
| Aree Operative UAS | Aree Operative UAS | Complete | Documento dedicato alle aree dichiarate, allo stato realtime e ai limiti. |
| Traffico Droni | Drone Tracking | Complete | Documento esistente ricollocato come layer realtime. |
| Volo sportivo | Volo sportivo | Complete | Documento dedicato al layer GLIDER e alle sorgenti cooperative. |
| Aerei sotto i 1000 m | Air Traffic | Complete | Documento esistente ricollocato come layer realtime. |
| Layer meteo | docs/user/weather-layers.md |
Planned | Da valutare insieme alla futura pagina meteo, evitando duplicazioni con Meteo puntuale. |
Strumenti¶
Gli strumenti sono esclusivamente le funzioni presenti nel menu Tools. I nomi devono rimanere uguali alle etichette mostrate nell'interfaccia.
| Strumento | Documento | Stato | Scelta documentale |
|---|---|---|---|
| Introduzione agli strumenti | Strumenti | Complete | Pagina guida del menu Tools. |
| Zone sovrapposte | Pannello informazioni zona | Complete | Sufficiente il riferimento al pannello informazioni e alla sezione in tools.md. |
| Meteo puntuale | Meteo puntuale | Complete | Documento dedicato a meteo locale, previsioni e analisi vento. |
| Misura distanze | Misura distanze | Complete | Documento dedicato alla misura tra due punti sulla mappa. |
| Profilo altimetrico | Profilo altimetrico | Complete | Documento dedicato a selezione percorso, DEM, grafico e limiti. |
| Copertura radio | Copertura radio | Complete | Documento dedicato a raggio, altezza drone, griglia LOS e limiti del risultato. |
| Autorizzazioni di volo | Autorizzazioni di volo | Complete | Documento dedicato distinto dal Mission Planner. |
| Spazio aereo 3D | Spazio aereo 3D | Complete | Documento dedicato a selezione area, viewer Cesium, quote e limiti. |
| Sole e ombre | Sole e ombre | Complete | Documento dedicato a simulazione solare, ombre e finestre di luce. |
| Mission Planner | Mission Planner | Complete | Documento esistente ricollocato come strumento. |
Altre Sezioni Utente¶
| Sezione | Documento | Stato | Note |
|---|---|---|---|
| Overview | User Overview | Complete | Introduzione generale per utilizzatori. |
| Dashboard | Dashboard | Complete | Schermata principale e controlli generali. |
| Mappa | Mappa | Complete | Include mappe di sfondo Satellite e Topo. |
| Pannello informazioni zona | Pannello informazioni zona | Complete | Documento trasversale richiamato da mappa, layer e strumenti. |
| Settings | docs/user/settings.md |
Planned | Da creare dopo ispezione delle impostazioni realmente presenti. |
| FAQ | docs/user/faq.md |
Planned | Da creare quando le pagine operative principali saranno piu' complete. |
| Troubleshooting | docs/user/troubleshooting.md |
Planned | Da creare con problemi verificati e soluzioni basate sul codice. |
Fonte Dei Contenuti¶
Il codice e' la fonte principale della documentazione.
Regole operative:
- non documentare funzionalita' non verificabili nel repository;
- non usare il
README.mdcome fonte primaria, perche' e' datato; - non duplicare contenuti tra pagine diverse;
- aggiornare documenti esistenti invece di riscriverli senza necessita';
- mantenere separata la documentazione utente da quella developer.
Documentation Status¶
| Area | Documento | File previsto | Stato |
|---|---|---|---|
| Foundation | Documentation Guidelines | docs/DOCUMENTATION.md |
Complete |
| Foundation | Documentation Home | docs/index.md |
Complete |
| Product | Product Overview | docs/product-overview.md |
Complete |
| Product | Product Vision | docs/product-vision.md |
Complete |
| Product | Release Notes | docs/release-notes.md |
Planned |
| Product | Glossary | docs/glossary.md |
Planned |
| User / Overview | Overview | docs/user/overview.md |
Complete |
| User / Dashboard | Dashboard | docs/user/dashboard.md |
Complete |
| User / Mappa | Mappa | docs/user/map.md |
Complete |
| User / Mappa | Pannello informazioni zona | docs/user/zone-information-panel.md |
Complete |
| User / Layer | Introduzione layer | docs/user/layers.md |
Complete |
| User / Layer | Zone di volo | docs/user/flight-zones.md |
Complete |
| User / Layer | NOTAM | docs/user/notam.md |
Complete |
| User / Layer | Infrastrutture aeronautiche | docs/user/aeronautical-infrastructures.md |
Complete |
| User / Layer | Aree Operative UAS | docs/user/uas-operational-areas.md |
Complete |
| User / Layer | Traffico Droni | docs/user/drone-tracking.md |
Complete |
| User / Layer | Volo sportivo | docs/user/sport-flight.md |
Complete |
| User / Layer | Aerei sotto i 1000 m | docs/user/air-traffic.md |
Complete |
| User / Layer | Layer meteo | docs/user/weather-layers.md |
Planned |
| User / Strumenti | Introduzione strumenti | docs/user/tools.md |
Complete |
| User / Strumenti | Zone sovrapposte | docs/user/zone-information-panel.md |
Complete |
| User / Strumenti | Meteo puntuale | docs/user/point-weather.md |
Complete |
| User / Strumenti | Misura distanze | docs/user/distance-measurement.md |
Complete |
| User / Strumenti | Profilo altimetrico | docs/user/elevation-profile.md |
Complete |
| User / Strumenti | Copertura radio | docs/user/radio-coverage.md |
Complete |
| User / Strumenti | Autorizzazioni di volo | docs/user/flight-authorizations.md |
Complete |
| User / Strumenti | Spazio aereo 3D | docs/user/airspace-3d.md |
Complete |
| User / Strumenti | Sole e ombre | docs/user/sun-shadows.md |
Complete |
| User / Strumenti | Mission Planner | docs/user/flight-planning.md |
Complete |
| User / Settings | Settings | docs/user/settings.md |
Planned |
| User / FAQ | FAQ | docs/user/faq.md |
Planned |
| User / Troubleshooting | Troubleshooting | docs/user/troubleshooting.md |
Planned |
| Developer | Architecture | docs/developer/architecture.md |
Complete |
| Developer | Repository | docs/developer/repository.md |
Complete |
| Developer | Backend | docs/developer/backend.md |
Complete |
| Developer | Frontend | docs/developer/frontend.md |
Complete |
| Developer | Database | docs/developer/database.md |
Planned |
| Developer | GeoJSON | docs/developer/geojson.md |
Planned |
| Developer | Data Sources | docs/developer/data-sources.md |
Complete |
| Developer | Schedule Engine | docs/developer/schedule-engine.md |
Complete |
| Developer / Data Sources | Geozones | docs/developer/datasets/geozones.md |
Complete |
| Developer / Data Sources | Airports | docs/developer/datasets/airports.md |
Complete |
| Developer / Data Sources | ENR | docs/developer/datasets/enr.md |
Complete |
| Developer / Data Sources | SUP | docs/developer/datasets/sup.md |
Complete |
| Developer / Data Sources | NOTAM | docs/developer/datasets/notam.md |
Complete |
| Developer / Data Sources | METAR e Weather | docs/developer/datasets/metar-weather.md |
Complete |
| Developer / Data Sources | DEM | docs/developer/datasets/dem.md |
Complete |
| Developer / Data Sources | ADS-B e OGN | docs/developer/datasets/adsb-ogn.md |
Complete |
| Developer / Data Sources | Realtime | docs/developer/datasets/realtime.md |
Complete |
| Developer / Data Sources | Firestore | docs/developer/datasets/firestore.md |
Complete |
| Developer / Data Sources | Deployment | docs/developer/datasets/deployment.md |
Complete |
| Developer | Update System | docs/developer/update-system.md |
Planned |
| Developer | APIs | docs/developer/apis.md |
Planned |
| Developer | Cloud Functions | docs/developer/cloud-functions.md |
Planned |
| Developer | Firestore Collections | docs/developer/firestore-collections.md |
Planned |
| Developer | Traffic Ingestion | docs/developer/traffic-ingestion.md |
Planned |
| Developer | Tracker Heartbeat | docs/developer/tracker-heartbeat.md |
Planned |
| Developer | AI Integration | docs/developer/ai-integration.md |
Planned |
| Developer | Coding Guidelines | docs/developer/coding-guidelines.md |
Planned |
| Developer | Roadmap | docs/developer/roadmap.md |
Planned |