Questa pagina contiene i dettagli di un progetto di scrittura tecnica accettato per la stagione dei documenti Google.
Riepilogo del progetto
- Organizzazione open source:
- Associazione Wordnet globale
- Technical writer:
- Yoyo Wu
- Nome progetto:
- Struttura WordPress
- Durata del progetto:
- Durata standard (3 mesi)
Project description
Perché questo progetto
In qualità di Technical writer e specializzata in linguistica, sono felice di trovare un progetto di questo tipo, con l'idea di collegare lingue diverse insieme a un framework semantico-concettuale unificato, e che è stato applicato ad aziende 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 saranno utili per i principianti. Anche se tutte le relazioni nel wordnet sono implementate in un modello unificato, alcune relazioni non dispongono delle 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. Le definizioni e gli esempi brevi sono privi di un pattern di frase unificato, poiché lo Short e l'esempio breve sono quelli che si riferiscono ai callout quando l'utente passa il mouse sopra la relazione specifica. Le definizioni e l'esempio svolgono il ruolo principale di introdurre la relazione e devono essere strutturati in pattern unificati ma diversi rispetto alle loro controparti brevi. I test provengono da EWN, ma il blocco delle condizioni deve essere anteposto al corpo del test principale, poiché gli utenti controlleranno sempre le condizioni prima per decidere se i loro dati linguistici corrispondono alle condizioni e poi per sostenere il test. Inoltre, il corpo del test non è così semplice con molti acronimi linguistici. I contenuti della sezione Commenti sono diversificati; a volte enfatizza un punto particolare della definizione, a volte riporta dettagli specifici del progetto. Penso che dovremmo impostare uno standard per questa sezione. Spostare le informazioni su progetti specifici nella sezione Nomi specifici dei progetti dovrebbe essere più pratico per gli utenti. La sezione Nomi specifici dei progetti riepiloga il nome della relazione in tutti i progetti; questa sezione deve essere esaminata poiché si verificano errori di mancata corrispondenza. Devi inserire un link nel Glossario dei termini direttamente nel documento e aggiungere tutti gli acronimi e i termini che potrebbero non essere familiari al principiante.
Linee guida
Vorrei inoltre discutere di due argomenti di seguito con il team di progetto prima di redigere i documenti; la conclusione ricevuta servirà da linee guida generali per l'intero progetto.
Informazioni sul pubblico Ecco un esempio reale di me, anche se sono una specializzazione linguistica. Quando imbatto per la prima volta il documento originale, non so cosa significhi "synset", è sulla pagina web di Princeton Wordnet che trovo il significato di synset.
Quindi all'inizio dobbiamo capire la struttura delle conoscenze del pubblico potenziale. Se non possiamo garantire che tutto il pubblico sia dotato di conoscenze pertinenti, dobbiamo almeno aggiungere una sezione Panoramica, collegare il Glossario dei termini e altre risorse correlate per guidarli attraverso il Wordnet e i progetti correlati. Dovremmo sempre tenere a mente questo presupposto durante l'intero processo di documentazione,
Informazioni sulla funzione dei documenti In base a quanto ho capito, l'obiettivo dei documenti sulla struttura di wordnet è aiutare gli utenti ad acquisire familiarità con tutti i tipi di relazioni nel wordnet e gli utenti possono raggruppare le parole in tali relazioni in base alle informazioni fornite. Tuttavia, i documenti originali sono più simili a estratti di articoli accademici. Se lo scopo dei documenti è un riferimento accademico, non è un problema, ma se il suo scopo è quello di guidare gli utenti, è necessario che ci sia un compromesso tra il mondo accademico e l'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 dell'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 sulle relazioni costitutive.
- Settimana 5 - Settimana 6: scrivi la parte delle relazioni Altro e Dominio.
- Settimana 7 - Settimana 8: Scrivi la parte delle relazioni con 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 riepilogo di questo progetto.