Esta página contém os detalhes de um projeto de escrita técnica aceito para a temporada de documentos do Google.
Resumo do projeto
- Organização de código aberto:
- Associação global de Wordnet
- Redator técnico:
- Yoyo Wu
- Nome do projeto:
- Estrutura do Wordnet
- Duração do projeto:
- Duração padrão (3 meses)
Project description
Por que este projeto
Como escritor técnico com especialização em linguística, fico feliz em encontrar um projeto desse tipo, com a ideia de vincular diferentes idiomas a uma estrutura semântica e conceitual unificada, e que tenha sido aplicado a negócios do mundo real, como o Google Tradutor. Eu gostaria de contribuir com os documentos desse projeto para que ele seja mais fácil de usar para o público.
Issues
Analisei o documento original e acho que podemos melhorá-lo resolvendo os problemas abaixo: Falta de uma seção Visão geral no início para apresentar os conceitos básicos do Wordnet, o que será útil para iniciantes. Embora todas as relações no Wordnet sejam lançadas em um modelo unificado, algumas relações não têm as informações necessárias, como exemplos e testes, que estão distribuídos na página da Web do Princeton Wordnet, nas diretrizes gerais da EuroWordnet e em outros recursos. A definição e a definição abreviadas, o exemplo curto e o exemplo não têm um padrão de frase unificado, já que os exemplos curtos e de definição curta são as frases de destaque quando o usuário passa o mouse sobre a relação específica. Definição e exemplo têm a função principal de apresentar a relação. Eles precisam ser estruturados em padrões unificados, mas diferentes, das contrapartes curtas. Os testes são do EWN, mas o bloco de condições deve ser colocado à frente do corpo de teste principal, já que os usuários sempre vão analisar as condições primeiro para decidir se os dados linguísticos correspondem às condições e, depois, fazer o teste. O corpo do teste também não é tão simples com muitas siglas linguísticas. O conteúdo da seção Comentários é diversificado e às vezes enfatiza um ponto específico da definição, outras vezes indica detalhes específicos do projeto. Acho que devemos definir um padrão para esta seção. Mover informações sobre projetos específicos para a seção "Nomes específicos do projeto" será mais conveniente para os usuários. A seção "Nomes específicos do projeto" resume o nome da relação em todos os projetos. Essa seção precisa ser revisada, já que ocorrem erros de incompatibilidade. É necessário vincular o Glossário de termos diretamente ao documento e adicionar todas as siglas e termos que os novatos não venham a conhecer.
Diretrizes
Também gostaria de discutir abaixo dois tópicos com a equipe do projeto antes de redigir os documentos. A conclusão recebida servirá como diretrizes gerais para todo o projeto.
Sobre o público Este é um exemplo real de mim mesmo, embora seja um formado em linguística, quando encontro o documento original pela primeira vez, não sei o que significa "sinset". É na página da Web do Princeton Wordnet que encontro o significado de sintaxe.
Primeiro, precisamos entender a estrutura de conhecimento do público em potencial. Se não conseguirmos garantir que todos os espectadores tenham conhecimento relevante, pelo menos precisamos adicionar uma seção "Visão geral", vincular o glossário de termos e outros recursos relacionados para guiá-los pelo Wordnet e seus projetos relacionados. Devemos sempre manter essa suposição em mente durante todo o processo de documentação,
Sobre a função dos documentos De acordo com meu entendimento, o objetivo dos documentos de estrutura do wordnet é ajudar os usuários a se familiarizarem com todos os tipos de relação no Wordnet, e os usuários podem agrupar palavras nessas relações com base nas informações fornecidas. No entanto, os documentos originais parecem mais trechos de trabalhos acadêmicos. Se o propósito dos documentos é referência acadêmica, tudo bem, mas se eles servirem ao objetivo de orientar os usuários, é preciso haver compensações entre academia e utilidade.
Vantagens
Posso ajudar a traduzir a versão em chinês dos documentos. Tenho experiência na tradução de artigos linguísticos do inglês para o chinês. Posso ajudar a formatar os documentos, conheço os conceitos básicos de HTML/CSS e posso ajudar a melhorar a aparência da página da Web, como adicionar uma barra de navegação lateral. Posso ajudar a desenhar alguns fluxogramas usando o Visio ou o Mermaid se puderem ajudar os usuários a compreender melhor as relações.
Marcos / tempo / meta
- Semana 1: discutir e definir a meta, o fluxo de trabalho e o plano de trabalho com a equipe do projeto.
- Semana 2: organize o esboço dos documentos e escreva a seção Visão geral.
- Semanas 3 a 4: escrever a parte sobre relações constitutivas.
- Semana 5 - Semana 6: Escrever a parte sobre as relações com o outro e o domínio.
- Semanas 7 a 8: escrever a parte de relações de papel.
- Semana 9: escrever as três relações restantes e atualizar o glossário.
- Semana 10: traduza a versão em chinês, se necessário.
- Semana 11: revise o formato dos documentos.
- Semana 12: verificação final e resumo do projeto.