Esta página contém os detalhes de um projeto de escrita técnica aceito para o Temporada dos Documentos Google.
Resumo do projeto
- Organização de código aberto:
- Global Wordnet (em inglês)
- Redator técnico:
- Kumar
- Nome do projeto:
- O Open Multilingual Wordnet (OMW)
- Duração do projeto:
- Duração padrão (três meses)
Project description
Solicitação de projeto:
Entrei em contato com os mentores da Global Wordnet Association e enviei uma solicitação de pull que foi analisada favoravelmente. Se possível, posso dedicar 40 horas (ou mais) por semana a este projeto. Tenho bom entendimento de Python, Git, HTML, C++, Java e C. Sou bilíngue e falo fluentemente inglês e hindi. Aprendi francês na escola e sei um pouco de alemão. Estou muito interessado e entusiasmado em contribuir para a Associação Global de Wordnet por meio deste projeto, se tiver uma chance de trabalhar com a maior dedicação.
Estado atual:
A documentação atual do Open Multilingual Wordnet é superficial e incompleta. Os guias de usuário atuais não têm conteúdo, gráficos, exemplos e instruções explícitas. Não há um guia do usuário para ajudar alguém a pesquisar a wordnet, como ler as páginas retornadas, como instalar, como enviar feedback. Há alguma documentação sobre como contribuir com um novo Wordnet, mas ela não é completa nem clara para orientar alguém sobre como participar do Wordnet multilíngue aberto. Não há documentação sobre como interagir com o índice colaborativo interlinguístico (CILI, na sigla em inglês). Há uma página de introdução ao CILI, que não tem informações como por que e como descontinuar e substituir conceitos, avaliando novos candidatos. No geral, faltam conteúdo, clareza, exemplos e recursos visuais nas documentações atuais para oferecer ajuda.
Plano:
Planejei executar este projeto em quatro fases. Na fase A, vou documentar um guia para alguém que está contribuindo com uma nova rede de palavras. Nesta fase, vou abordar como criar uma rede de palavras bem formatada, como fazer o upload dela e como entender o feedback. Na próxima fase B, vou documentar um guia para alguém que pesquisa a wordnet (ou família de wordnets). Nessa documentação, abordarei como ler as páginas retornadas, como fazer o download e como fornecer feedback. Na fase C, vou documentar um guia para interagir com o índice interlinguístico colaborativo, como descontinuar e substituir conceitos e avaliar novos candidatos. Na fase D, preencherei a documentação do Open Multilingual Wordnet, melhorarei a documentação existente deste projeto em relação à documentação abordada nas fases A, B e C. Como há sobreposição entre os projetos da GWA, a fase D também será dedicada aos requisitos organizacionais. Planejei alocar as semanas 1,2 e 3 para a fase A, as semanas 4,5 e 6 para a fase B, as semanas 7,8 e 9 para a fase C e as semanas 10 e 11 para a fase D.
Objetivos do projeto:
1) Analisar a documentação e determinar qual seção precisa de melhorias.
2) Reconstrução da estrutura da documentação existente.
3) Documentar um guia para alguém que está contribuindo com uma nova rede de palavras.
4) Documentar um guia para alguém que esteja pesquisando no wordnet.
5) Documentar um guia para interagir com o índice colaborativo interlinguístico.
6) Adicionar exemplos e recursos visuais à documentação.
7) Preencher as páginas existentes em que a documentação parece superficial.
Cronograma:
Fase de vinculação à comunidade: 17 de agosto a 13 de setembro.
- Nesse período, vou interagir com a comunidade e conhecê-la melhor.
- Configure um canal de comunicação.
- Defina um horário para a comunicação.
- Refine as metas e defina as expectativas em ambos os lados.
Fase de desenvolvimento do documento (14 de setembro a 30 de novembro)
- Vou trabalhar de perto com meus mentores e concluir meu projeto nesta fase de acordo com os planos semanais.
- Concluir qualquer pesquisa dos administradores do programa do Google.
Semanas 1 a 3 (14 a 27 de setembro)
- Fase A da documentação
Semana 1 (14 a 20 de setembro)
- A documentação de um guia para alguém que colabora com o novo Wordnet será iniciada.
- Esta semana vou fazer a documentação, como criar uma rede de palavras bem formatada.
- Instruções claras para converter o wordnet do usuário para a definição pública do tipo de documento (DTD) do Wordnet LMF serão documentadas.
- As ferramentas de conversão também serão abordadas.
Semana 2 (21 a 27 de setembro)
- Esta semana, vou fazer a documentação sobre como fazer o upload de uma rede de palavras (depois de converter para a definição de tipo de documento Wordnet LMF) para a OMW.
- A documentação atual é superficial (mas precisa). Vou preenchê-la e adicionar exemplos à documentação.
Semana 3 (28 de setembro a 4 de outubro)
- Esta semana será usada para documentar como entender o feedback.
- Essa documentação precisa ser criada do zero, já que não há documentação sobre o assunto.
Semanas 4 a 6 (5 a 25 de outubro)
- Fase B da documentação
Semana 4 (5 a 11 de outubro)
- Esta semana começarei a documentar um guia para quem pesquisa a wordnet (ou família de wordnets).
- Esta semana, vou escrever a documentação sobre como ler as páginas retornadas.
Semana 5 (12 a 18 de outubro)
- Esta semana vou documentar como fazer o download.
- Não há documentação para isso. É necessário escrever do zero.
Semana 6 (19 a 25 de outubro)
- Esta semana vou documentar como enviar feedback à organização.
- Como não há documentação anterior para referência, este artigo também será escrito do zero.
Semana 6 a 9 (26 de outubro a 15 de novembro)
- Fase C da documentação
Semana 7 (26 de outubro a 1º de novembro)
- Esta semana vou começar a documentar um guia para interagir com o índice interlinguístico colaborativo (CILI, na sigla em inglês).
- Esta semana vou documentar como e por que descontinuar e substituir conceitos.
Semana 8 (2 a 8 de novembro)
- Esta semana vou documentar mais informações sobre o CILI e escrever instruções sobre como fazer o download do CILI e atender aos requisitos organizacionais na documentação do CILI. Essa documentação precisa ser escrita do zero.
Semanas 9 a 11 (9 a 29 de novembro)
- Fase D da documentação
Semana 9 (9 a 15 de novembro)
- O OMW 2.0 será desenvolvido agora, de acordo com as necessidades organizacionais.
Semana 10 (16 a 22 de novembro)
- A documentação da página inicial do Open Multilingual Wordnet (OMW) parecia superficial. Esta semana vou trabalhar nela e adicionar outras informações relacionadas ao OMW. Também vou verificar quais outras páginas do OMW precisam ser preenchidas.
- As páginas de OMW que faltam serão melhoradas e, sempre que possível, vou tentar adicionar recursos visuais nelas.
Semana 11 (23 a 29 de novembro)
- Como há sobreposição nos projetos da GWA, esta semana está reservada para atender a essas necessidades organizacionais e a outras documentações diversas.
Fase de finalização e avaliação do projeto (30 de novembro a 5 de dezembro)
- Esta semana será dedicada à revisão da documentação para encontrar erros de digitação e outros.
- Vou escrever meu relatório de projeto.
- Vou pedir aos meus mentores para revisar meu relatório de projeto.
- Vou finalizar e enviar meu relatório de projeto.
- Vou escrever e enviar uma avaliação dos meus mentores e da minha experiência na Temporada de documentos.
Comunicação:
A frequência do contato vai depender de uma conversa com os mentores. Eu prefiro uma comunicação regular. Minha sugestão é duas vezes por semana para fornecer uma atualização e receber feedback sobre o trabalho feito até agora. No entanto, isso também é flexível, dependendo das preferências.
Por que este projeto?
Tenho interesse em linguística, e a ideia de conectar wordnets para todos os idiomas do mundo me intrigou a ponto de me juntar à Global Wordnet Association e contribuir com esse projeto. O conceito de Wordnet multilíngue aberto é admirável, em que as redes de palavras individuais são vinculadas a redes de palavras em outros idiomas, o que facilita o acesso a elas. O Open Multilingual Wordnet e seus componentes podem ser usados, modificados e compartilhados por qualquer pessoa, para qualquer finalidade. Embora a GWA tenha uma ideia sólida e uma intenção nobre, a organização não é muito conhecida e é subestimada. Provavelmente, um dos motivos é a documentação superficial e a falta de guias do usuário para ajudar na contribuição e no uso. Percebi que o projeto Open Multilingual Wordnet é algo em que posso contribuir para ajudar a Global Wordnet Association e a comunidade de código aberto em geral.
Planos futuros:
Depois de concluir o GSoD 20, vou continuar contribuindo para a Global Wordnet Association em outros projetos. Com certeza, vou participar de qualquer conferência da organização se tiver a chance.