Esta página contém os detalhes de um projeto de redação técnica aceito para a Google Season of Docs.
Resumo do projeto
- Organização de código aberto:
- Global Wordnet Association (em inglês)
- Redator técnico:
- Yoyo Wu
- Nome do projeto:
- Estrutura do Wordnet
- Duração do projeto:
- Duração padrão (três meses)
Project description
Por que esse projeto?
Como escritor técnico com graduação em linguística, fico feliz em encontrar esse projeto, com a ideia de vincular diferentes idiomas com uma estrutura semântico-conceitual unificada, e que tenha sido aplicado a negócios do mundo real, como o Google Tradutor. Gostaria de contribuir com os documentos deste projeto para torná-lo mais fácil de usar para o público.
Problemas
Analisei o documento original e acho que podemos melhorá-lo resolvendo os problemas abaixo: Falta de uma seção de visão geral no início para apresentar os conceitos básicos do WordNet, que serão úteis 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 são distribuídos na página da Web do Princeton Wordnet, nas diretrizes gerais do EuroWordnet e em outros recursos. A definição curta e a definição, os exemplos curtos e o exemplo não têm um padrão unificado de frases, já que a definição curta e o exemplo curto são as frases de destaque quando o usuário passa o mouse sobre a relação específica, a definição e o exemplo têm a função principal de apresentar a relação. Elas precisam ser estruturadas em padrões unificados, mas diferentes das contrapartes curtas. Os testes são do EWN, mas o bloco de condições precisa ser colocado antes do corpo principal do teste, já que os usuários sempre vão analisar as condições primeiro para decidir se os dados linguísticos correspondem a elas e depois fazer o teste. O corpo do teste também não é tão simples, com muitos acrônimos linguísticos. O conteúdo da seção "Comentários" é diversificado, às vezes enfatiza um ponto específico da definição, às vezes declara 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 deve 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 analisada, já que erros de incompatibilidade podem ocorrer. É necessário vincular o glossário de termos diretamente ao documento e adicionar todos os acrônimos e termos que podem ser desconhecidos para iniciantes.
Diretrizes
Também gostaria de discutir dois tópicos abaixo com a equipe do projeto antes de elaborar os documentos. A conclusão recebida vai servir como diretrizes gerais para todo o projeto.
Sobre o público Este é um exemplo real de mim, embora eu tenha formação em linguística, quando encontro o documento original pela primeira vez, não sei o que significa "synset", mas é na página da Web do Princeton Wordnet que encontro o significado de synset.
Então, primeiro precisamos descobrir a estrutura de conhecimento do público-alvo em potencial. Se não for possível garantir que todo o público tenha o conhecimento relevante, pelo menos precisamos adicionar uma seção de visão geral, vincular o glossário de termos e outros recursos relacionados para orientar o público pela 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 Pelo que entendi, 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 eles podem agrupar palavras nessas relações com base nas informações fornecidas. No entanto, os documentos originais parecem mais com extratos de artigos acadêmicos. Se o objetivo dos documentos for referência acadêmica, tudo bem, mas se o objetivo for orientar os usuários, é preciso haver um equilíbrio entre a academia e a utilidade.
Vantagens
Posso ajudar a traduzir a versão em chinês dos documentos. Tenho experiência na tradução de trabalhos linguísticos do inglês para o chinês. Posso ajudar a formatar os documentos, sei o básico de HTML/CSS e posso ajudar a melhorar a aparência da página da Web dos documentos, como adicionar uma barra de navegação lateral. Posso ajudar a desenhar alguns fluxogramas usando o Visio ou o Mermaid, se isso ajudar os usuários a entender 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: definir o esboço do documento e escrever a seção "Visão geral".
- Semanas 3 a 4: escreva a parte sobre relações constitutivas.
- Semanas 5 a 6: escreva a parte "Relações de outro" e "Domínio".
- Semana 7 a 8: escreva a parte sobre relações de função.
- Semana 9: escrever as três relações restantes e atualizar o glossário.
- Semana 10: traduzir a versão em chinês, se necessário.
- Semana 11: revisar o formato dos documentos.
- Semana 12: verificação final e resumo do projeto.