Questa pagina contiene i dettagli di un progetto di scrittura tecnica accettato per la stagione dei documenti Google.
Riepilogo del progetto
- Organizzazione open source:
- Open Food Facts
- 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 della "stagione dei documenti" tramite un'email che ho ricevuto dall'insegnante 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 realmente identificarmi. Era qualcosa che avrei fatto oltre al mio normale lavoro e, se l'avessi fatto, deve essere divertente e significativo.
Quando ho letto la descrizione di Open Food Facts, sapevo di aver trovato quel progetto. Adoro prendermi cura del mio corpo e della mia salute con attività fisica e 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 sul cibo e sui cosmetici che utilizziamo. Open Food Facts mette queste informazioni a nostra disposizione e voglio contribuire a questa incredibile 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 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 Generali, LEGGI, SCRITTE). Inoltre, vorrei impostare, insieme ai team di sviluppo, un modo per generare automaticamente la documentazione dell'API dal codice (questo richiede tempo, è per questo che propongo una collaborazione a lungo termine).
Sappiamo tutti che l'aspetto è importante ;) Ecco perché possiamo anche modificare il codice CSS e il logo dell'API REST per allineare l'interfaccia utente spavalda alla documentazione utente.
Non vedo l'ora di lavorare con te a questo progetto.