Questa pagina contiene i dettagli di un progetto di documentazione tecnica accettato per la stagione della documentazione di Google.
Riepilogo del progetto
- Organizzazione open source:
- Wordnet globale
- Technical Writer:
- Kumar
- Nome del progetto:
- Open Multilingual Wordnet (OMW)
- Durata del progetto:
- Durata standard (3 mesi)
Project description
Richiesta di progetto:
Ho contattato i mentor della Global Wordnet Association e ho inviato una pull request che è stata esaminata positivamente. Se mi viene data la possibilità, posso dedicare 40 ore (o più) a settimana a questo progetto. Ho una buona conoscenza di Python, Git, HTML, C++, Java e C. Sono bilingue e parlo fluentemente inglese e hindi, ho imparato il francese a scuola e conosco anche un po' di tedesco. Sono molto entusiasta di contribuire alla Global Wordnet Association tramite questo progetto e, se mi verrà data la possibilità, lavorerò con la massima dedizione.
Stato attuale:
L'attuale documentazione aperta su Wordnet multilingue è bassa e incompleta con la mancanza di contenuti, immagini, esempi e istruzioni esplicite per l'utente. Non esiste una guida per gli utenti che aiuta a eseguire ricerche nel wordnet, a leggere le pagine restituite, a installare il servizio e a fornire feedback. Esiste una certa documentazione sul contributo di nuovi wordnet, ma non è completa né chiara per indicare a qualcuno come partecipare a Open Multilingual Wordnet. Non esiste alcuna documentazione su come interagire con il Collaborative Interlingual Index (CILI). Esiste una pagina introduttiva a CILI, che non contiene informazioni quali il motivo, nonché le modalità per ritirare e sostituire i concetti, valutando i nuovi candidati. In generale, la documentazione attuale non è sufficientemente chiara, completa ed esaustiva, né contiene esempi e immagini.
Piano:
Ho pianificato di eseguire questo progetto in quattro fasi. Nella fase A, preparerò una guida per chi contribuisce con nuovi wordnet. In questa fase verrà spiegato come creare wordnet ben formattati, come caricarli e come interpretare i feedback. Nella prossima fase B, documenterò una guida per chi cerca il Wordnet (o la famiglia di Wordnet). In tale documentazione, tratterò come leggere le pagine restituite, come scaricare i Wordnet e come fornire un feedback. Nella fase C, preparerò una guida per interagire con l'indice interlinguistico collaborativo, su come ritirare e sostituire i concetti e sulla valutazione dei nuovi candidati. Nella fase D, completerò la documentazione di Open Multilingual Wordnet e migliorerò la documentazione esistente di questo progetto, ad eccezione di quella trattata nelle fasi A, B e C. Poiché i progetti di GWA si sovrappongono, la fase D sarà dedicata anche ai requisiti organizzativi. Ho pianificato di allocare le settimane 1,2 e 3 alla fase A, le settimane 4,5 e 6 alla fase B, le settimane 7,8 e 9 alla fase C e le settimane 10 e 11 alla fase D.
Obiettivi del progetto:
1) Analisi della documentazione esistente e determinazione della sezione che richiede miglioramenti.
2) Ricostruzione della struttura della documentazione esistente.
3) Documentare una guida per chi contribuisce in un nuovo Wordnet.
4) Documentare una guida a chi cerca il Wordnet.
5) Documentazione di una guida per interagire con l'indice interlinguistico collaborativo.
6) Aggiunta di esempi e immagini alla documentazione.
7) Compilare le pagine esistenti in cui la documentazione sembra superficiale.
Sequenza temporale
Fase di creazione di un legame con la community: 17 agosto - 13 settembre.
- In questo periodo interagirò con la community e la conoscerò meglio.
- Imposta un canale di comunicazione.
- Imposta un'ora per la comunicazione.
- Perfeziona gli obiettivi e definisci le aspettative su entrambi i lati.
Fase di sviluppo del documento (14 settembre-30 novembre)
- Collaborerò a stretto contatto con i miei mentor e completerò il mio progetto in questa fase in base ai piani settimanali.
- Completare qualsiasi sondaggio degli amministratori del programma Google.
Settimana 1-3 (14-27 settembre)
- Fase-A della documentazione
Settimana 1 (14-20 settembre)
- Inizierà la documentazione di una guida per chi contribuisce con nuovi wordnet.
- Questa settimana preparerò la documentazione su come creare un wordnet ben formattato.
- Verranno fornite istruzioni chiare per la conversione del wordnet dell'utente alla definizione del tipo di documento (DTD) LMF di Wordnet pubblico.
- Saranno trattati anche gli strumenti di conversione.
Settimana 2 (21-27 settembre)
- Questa settimana preparerò la documentazione su come caricare il proprio lessico controllato (dopo la conversione alla definizione del tipo di documento LMF di Wordnet) nell'OMW.
- La documentazione esistente è superficiale (ma accurata). La completerò e aggiungerò esempi.
Settimana 3 (28 settembre - 4 ottobre)
- Questa settimana verrà utilizzata per la documentazione su come interpretare il feedback.
- Questa documentazione deve essere scritta da zero, in quanto non esiste documentazione su questo argomento.
Settimana 4-6 (5-25 ottobre)
- Fase B della documentazione
Settimana 4 (5-11 ottobre)
- Questa settimana inizierò a documentare una guida per chi cerca il wordnet (o famiglia di Wordnet).
- Questa settimana scriverò la documentazione su come leggere le pagine restituite.
Settimana 5 (12-18 ottobre)
- Questa settimana documenterò come scaricare l'app.
- Non esiste documentazione per questa operazione, che deve essere scritta da zero.
Settimana 6 (19-25 ottobre)
- Questa settimana illustrerò come fornire feedback all'organizzazione.
- Poiché non esiste alcuna documentazione precedente a cui fare riferimento, anche questo verrà scritto da zero.
Settimane 6-9 (26 ottobre - 15 novembre)
- Fase C della documentazione
Settimana 7 (26 ottobre - 1° novembre)
- Questa settimana inizierò la documentazione di una guida per interagire con l'indice interlinguistico collaborativo (CILI)
- Questa settimana illustrerò come e perché ritirare e sostituire i concetti.
Settimana 8 (2-8 novembre)
- Questa settimana documenterò ulteriori informazioni su CILI e scriverò istruzioni su come scaricare CILI e soddisfare i requisiti organizzativi nella documentazione di CILI. Questa documentazione deve essere scritta da zero.
Settimane 9-11 (9-29 novembre)
- Fase D della documentazione
Settimana 9 (9-15 novembre)
- OMW 2.0 verrà sviluppato in base alle esigenze dell'organizzazione.
Settimana 10 (16-22 novembre)
- La documentazione della home page di Open Multilingual Wordnet (OMW) sembrava superficiale, questa settimana ci lavorerò e aggiungerò le informazioni aggiuntive relative a OMW e controllerò quali altre pagine esistenti di OMW devono essere compilate.
- La mancanza di pagine OMW verrà migliorata e, laddove possibile, cercherò di aggiungere immagini al suo interno.
Settimana 11 (23-29 novembre)
- Poiché i progetti di GWA presentano delle sovrapposizioni, questa settimana è riservata alla soddisfazione di queste esigenze organizzative sovrapposte e di altra documentazione varia.
Fase di finalizzazione e valutazione del progetto (30 novembre - 5 dicembre)
- Questa settimana verrà dedicata alla correzione della bozza della documentazione per rilevare errori ortografici e altri errori.
- Scriverò il report del progetto.
- Chiederò ai miei mentor di esaminare il report del progetto.
- Finalizzerò e invierò il report del progetto.
- Scriverò e invierò una valutazione dei miei mentor e della mia esperienza con la Stagione di Documenti.
Comunicazione:
La frequenza dei contatti dipenderà da una discussione con i mentor. Preferisco una comunicazione regolare. Il mio suggerimento è di fornire un aggiornamento due volte a settimana e ricevere un feedback sul lavoro svolto finora. Tuttavia, questo è flessibile anche in base alle loro preferenze.
Perché questo progetto?
Mi interesso di linguistica e l'idea di collegare le reti di parole per tutte le lingue del mondo mi ha spinto ad aderire alla Global Wordnet Association e a contribuire a questo progetto. Il concetto di Open Multilingual Wordnet è ammirevole quando i singoli wordnet sono collegati a wordnet in altre lingue, il che li rende più facilmente accessibili. Open Multilingual Wordnet e i suoi componenti possono essere utilizzati, modificati e condivisi liberamente da chiunque per qualsiasi scopo. Sebbene GWA abbia un'idea solida e un'intenzione nobile, l'organizzazione non è molto rinomata ed è sottovalutata. Probabilmente uno dei motivi è la documentazione superficiale e la mancanza di guide dell'utente che contribuiscano a dare il proprio contributo e a utilizzarlo. Ho capito che il progetto Open Multilingual Wordnet mi permette di contribuire ad assistere in comune la Global Wordnet Association e la community open source.
Piani futuri:
Dopo aver completato il GSoD 20, continuerò a dare il mio contributo alla Global Wordnet Association anche in altri progetti. Se mi verrà data la possibilità, parteciperò sicuramente a qualsiasi conferenza dell'organizzazione.