Questa pagina contiene i dettagli di un progetto di documentazione tecnica accettato per la stagione della documentazione di Google.
Riepilogo progetto
- Organizzazione open source:
- Informazioni aperte sul cibo
- Redattore tecnico:
- FutureOfDocs
- Nome del progetto:
- Documentare l'API Open Food Facts
- Durata del progetto:
- A lungo termine (5 mesi)
Project description
Ho sentito parlare per la prima volta della "Season of Docs" tramite un'email che ho ricevuto dall'insegnante di un corso sulla documentazione dell'API REST che ho seguito alcuni mesi fa. Anche se l'idea mi piaceva molto, ho deciso di presentare domanda per un progetto solo se avessi potuto identificarmi con esso. Era una cosa che avrei fatto oltre al mio lavoro abituale e, se lo facessi, dovevo essere divertente e significativo.
Quando ho letto la descrizione di Open Food Facts, ho capito di aver trovato il progetto che cercavo. Mi piace prendermi cura del mio corpo e della mia salute attraverso l'esercizio fisico e il cibo. Penso davvero che l'alimentazione sia una delle chiavi per una vita felice e che tutti dovremmo essere in grado di fare scelte migliori, il che è possibile solo se disponiamo di informazioni sufficienti sugli alimenti e sui cosmetici che utilizziamo. Open Food Facts mette a nostra disposizione queste informazioni e voglio contribuire a questa straordinaria iniziativa.
Negli ultimi tre anni ho lavorato come Technical Writer presso una società di sviluppo software specializzata nell'automazione di processi e release. Tra le altre, abbiamo implementato un'API REST con Swagger che consente agli sviluppatori di comunicare con le nostre applicazioni tramite richieste API. Ho aiutato i team di sviluppo a scrivere descrizioni migliori per le richieste/risposte e insieme abbiamo identificato quali informazioni sono necessarie per i nostri clienti per fornirle in modo chiaro e conciso.
Ho esaminato l'attuale sito dell'API Open Food Facts e penso che possiamo ristrutturare e migliorare la documentazione per renderla più user-friendly (pagine General, READ, WRITE). Inoltre, vorrei configurare, insieme ai team di sviluppo, un modo per generare automaticamente la documentazione dell'API dal codice (questa operazione richiede tempo, motivo per cui propongo una collaborazione a lungo termine).
Sappiamo tutti che l'aspetto è importante ;) Ecco perché possiamo anche modificare il CSS e il logo dell'API REST per allineare l'interfaccia utente di Swagger alla documentazione utente.
Non vedo l'ora di collaborare con te a questo progetto.