Questa pagina contiene i dettagli di un progetto di scrittura tecnica accettato per Google Season of Docs.
Riepilogo del progetto
- Organizzazione open source:
- Apri le informazioni gastronomiche
- Technical writer:
- FutureOfDocs
- Nome progetto:
- Documenta l'API Open Food Facts
- Durata del progetto:
- Lunga esecuzione (5 mesi)
Project description
Ho sentito parlare per la prima volta di "Stagione dei documenti" tramite un'email che ho ricevuto dal docente di un corso sulla documentazione dell'API REST che ho seguito alcuni mesi fa. Nonostante l'idea mi piacesse molto, ho deciso che avrei fatto domanda per un progetto solo se potevo identificarlo. Era qualcosa che avrei fatto oltre al mio normale lavoro e, se l'avevo fatto, deve essere divertente e significativo.
Quando ho letto la descrizione di Open Food Facts, ho capito di aver trovato il progetto. Mi piace prendermi cura del mio corpo e della mia salute con l'esercizio fisico e il cibo. Penso 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 abbiamo abbastanza informazioni sugli alimenti e sui cosmetici che utilizziamo. Open Food Facts mette a nostra disposizione queste informazioni e voglio contribuire a questa incredibile iniziativa.
Negli ultimi tre anni ho lavorato come Technical writer presso un'azienda di sviluppo software, specializzata nell'automazione di processi e release. Tra le altre cose, 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 e le risposte e insieme abbiamo identificato le informazioni necessarie ai nostri clienti per fornirle in modo chiaro e conciso.
Sto esaminando l'attuale sito dell'API Open Food Facts e penso che possiamo ristrutturare e migliorare la documentazione per renderla più facile da usare (pagine Generale, READ, WRITE). Inoltre, vorrei impostare, insieme ai team di sviluppo, un modo per generare automaticamente la documentazione dell'API dal codice (questa operazione richiede tempo, ecco perché propongo una collaborazione a lunga durata).
Sappiamo tutti che l'aspetto è importante ;) Ecco perché possiamo anche modificare il logo e il CSS dell'API REST in modo da allineare l'interfaccia utente spavalda con la documentazione dell'utente.
Non vedo l'ora di lavorare con te a questo progetto.