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:
- Associazione globale Wordnet
- Redattore tecnico:
- Yoyo Wu
- Nome progetto:
- Struttura di WordNet
- Durata del progetto:
- Durata standard (3 mesi)
Project description
Perché questo progetto
In qualità di Technical Writer con specializzazione in Linguistica, sono felice di trovare un progetto del genere, con l'idea di collegare lingue diverse con un quadro semantico-concettuale unificato, che è stato applicato a attività reali come Google Traduttore. Vorrei contribuire alla documentazione di questo progetto per renderlo più facile da usare per il pubblico.
Problemi
Ho esaminato il documento originale e penso che possiamo migliorarlo risolvendo i seguenti problemi: Mancanza di una sezione Panoramica all'inizio per introdurre le nozioni di base di Wordnet, che sarà utile ai principianti. Sebbene tutte le relazioni nel wordnet vengano implementate in un modello unificato, alcune relazioni mancano di informazioni necessarie, come esempi e test, che vengono distribuiti nella pagina web di Princeton Wordnet, nelle linee guida generali di EuroWordnet e in altre risorse. La definizione breve e la definizione, l'esempio breve e l'esempio mancano di un modello di frase unificato, poiché la definizione breve e l'esempio breve sono i callout quando il mouse dell'utente passa sopra la relazione specifica, la definizione e l'esempio hanno il ruolo principale di introdurre la relazione, devono essere strutturati in modelli unificati, ma diversi dalle loro controparti brevi. I test provengono da EWN, ma il blocco delle condizioni deve essere inserito prima del corpo del test principale, poiché gli utenti esamineranno sempre prima le condizioni per decidere se i loro dati linguistici corrispondono alle condizioni, quindi per sostenere il test. Inoltre, il testo del test non è così semplice, con molti acronimi linguistici. I contenuti della sezione Commenti sono diversificati: a volte sottolineano un punto specifico della definizione, a volte indicano dettagli specifici del progetto. Penso che dovremmo impostare uno standard per questa sezione. Spostare le informazioni su progetti specifici nella sezione Nomi specifici del progetto dovrebbe essere più pratico per gli utenti. La sezione Nomi specifici del progetto riassume il nome della relazione in tutti i progetti. Questa sezione deve essere esaminata poiché si verificano errori di mancata corrispondenza. È necessario collegare il Glossario dei termini direttamente al documento e aggiungere tutti gli acronimi e i termini che potrebbero non essere familiari ai principianti.
Linee guida
Prima di redigere la bozza dei documenti, vorrei anche discutere con il team di progetto i due argomenti riportati di seguito. Le conclusioni che riceveremo serviranno da linee guida generali per l'intero progetto.
Informazioni sul pubblico Ecco un esempio concreto di me, anche se sono un esperto linguistico, quando mi imbatto per la prima volta nel documento originale non so cosa significa "synset", ma è sulla pagina web di Princeton Wordnet che trovo il significato di synset.
Quindi, innanzitutto dobbiamo capire la struttura delle conoscenze del potenziale pubblico. Se non possiamo garantire che tutto il pubblico sia dotato di conoscenze pertinenti, almeno dobbiamo aggiungere una sezione Panoramica, collegare il Glossario dei termini e altre risorse correlate per guidarlo attraverso WordNet e i relativi progetti. Dobbiamo sempre tenere presente questo presupposto durante l'intera procedura di documentazione,
Informazioni sulla funzione dei documenti A quanto mi risulta, lo scopo dei documenti sulla struttura di WordNet è aiutare gli utenti a familiarizzare con tutti i tipi di relazioni in WordNet e a raggruppare le parole in queste relazioni in base alle informazioni fornite. Tuttavia, i documenti originali sembrano più estratti di articoli accademici. Se lo scopo della documentazione è di riferimento accademico, va bene, ma se ha lo scopo di guidare gli utenti, devono esserci dei compromessi tra accademia e utilità.
Vantaggi
Posso aiutarti a tradurre la versione cinese dei documenti. Ho esperienza nella traduzione di articoli linguistici dall'inglese al cinese. Posso aiutarti a formattare i documenti, conosco le nozioni di base di HTML/CSS e posso aiutarti a migliorare l'aspetto della pagina web dei documenti, ad esempio aggiungendo una barra di navigazione laterale. Posso aiutarti a disegnare alcuni diagrammi di flusso utilizzando Visio o Mermaid se questi possono aiutare gli utenti a comprendere meglio le relazioni.
Traguardi / Tempo / Obiettivo
- Settimana 1: discuti e stabilisci l'obiettivo, il flusso di lavoro e il piano di lavoro con il team di progetto.
- Settimana 2: stabilisci la struttura dei documenti e scrivi la sezione Panoramica.
- Settimana 3 - Settimana 4: scrivi la parte relativa alle relazioni costitutive.
- Settimana 5 - Settimana 6: scrivi la parte tra le relazioni Altro e Dominio.
- Settimana 7-8: scrivi la parte relativa alle relazioni tra i ruoli.
- Settimana 9: scrivi le tre relazioni rimanenti e aggiorna il glossario.
- Settimana 10: traduci la versione cinese, se necessario.
- Settimana 11: rivedi il formato dei documenti.
- Settimana 12: controllo finale e riassumi questo progetto.