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:
- Wordnet global
- Redator técnico:
- Kumar (link em inglês)
- Nome do projeto:
- The Open Multilíngue Wordnet (OMW)
- Duração do projeto:
- Duração padrão (3 meses)
Project description
Solicitação de projeto:
Entrei em contato com os mentores da Associação Global Wordnet e enviei uma solicitação de envio que foi analisada favoravelmente por eles. Se tiver a chance, posso dedicar 40 horas (ou mais) por semana nesse projeto. Tenho um bom conhecimento de Python, Git, HTML, C++, Java e C. Sou bilíngue e falo fluentemente inglês e hindi. Aprendi francês na escola e também conheço um pouco de alemão. Estou muito entusiasmado e entusiasmado em contribuir para a Associação Global Wordnet por este projeto, se tiver a chance de trabalhar com a maior dedicação.
Situação atual:
A documentação atual do Open Multilingual Wordnet é superficial e incompleta. Os guias do usuário existentes 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 o wordnet, como ler as páginas retornadas, como instalar, como fornecer feedback. Há documentação sobre como contribuir com o novo wordnet, mas essa documentação não está completa nem clara para orientar alguém sobre como participar do Open Multilíngue Wordnet. Não há documentação sobre como interagir com o Índice Interlíngue Colaborativo (CILI, na sigla em inglês). Há uma página de introdução do CILI sem informações como por que e como descontinuar e substituir conceitos, julgando novos candidatos. Em geral, faltam conteúdo, clareza, exemplos e recursos visuais na documentação atual para fins de assistência.
Plan:
Planejei executar este projeto em quatro fases. Na fase A, vou documentar um guia para alguém que contribua com o novo wordnet. Nesta fase, tratarei de como criar Wordnet bem formatado, como enviá-lo e como entender o feedback. Na próxima fase B, vou documentar um guia para alguém que esteja pesquisando o wordnet (ou família de wordnets). Nessa documentação, abordarei como ler as páginas retornadas, como fazer download e como fornecer feedback. Na fase C, documentarei um guia para interagir com o Índice interlíngue colaborativo, como descontinuar e substituir conceitos e julgar novos candidatos na fase C. Na fase D, preencherei a documentação do Open Multilíngue Wordnet, melhorarei a documentação existente deste projeto além da 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. Planejamos alocar as semanas 1,2 e 3 para a fase A, as semanas 4,5 e 6 serão alocadas para as fases B, as semanas 7,8 e 9 para as fases C e as semanas 10 e 11 para a fase D.
Metas do projeto:
1) analisar a documentação existente 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 o novo wordnet.
4) Documentar um guia para alguém que está pesquisando o wordnet.
5) Documentar um guia de interação com o Índice interlíngue colaborativo.
6) Adicionar exemplos e elementos visuais à documentação.
7) Preencher as páginas existentes onde a documentação parece superficial.
Linha do tempo:
Fase de vínculo com a comunidade: 17 de agosto a 13 de setembro.
- Nesse período, interagirei com a comunidade e a conhecerei melhor.
- Configure um canal de comunicação.
- Configure um horário de comunicação.
- Refine as metas e defina as expectativas de ambos os lados.
Fase de desenvolvimento de documentos (14 de setembro a 30 de novembro)
- Trabalharei em estreita colaboração com meus mentores e concluirei meu projeto nesta fase de acordo com os planos semanais.
- Responda a qualquer pesquisa dos administradores do programa do Google.
Semanas 1 a 3 (14 a 27 de setembro)
- Fase A de documentação
Semana 1 (14 a 20 de setembro)
- A documentação para um guia para alguém contribuindo com novo wordnet vai começar.
- Esta semana, farei a documentação sobre como criar Wordnet bem formatado.
- A instrução clara para converter o wordnet do usuário para a definição de tipo de documento (DTD) público do Wordnet LMF será documentada.
- As ferramentas de conversão também serão abordadas.
Semana 2 (21 a 27 de setembro)
- Esta semana, farei a documentação sobre como fazer upload do wordnet de alguém (após a conversão para a definição de tipo de documento do Wordnet LMF) para o OMW.
- A documentação existente é 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 os feedbacks fazem sentido.
- Esta documentação precisa ser escrita do zero, já que não há documentação sobre esse tópico.
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 alguém que pesquisa o wordnet (ou família de wordnets).
- Esta semana, escreverei uma 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 existe documentação existente para isso, é necessário redigir do zero.
Semana 6 (19 a 25 de outubro)
- Nesta semana, vou documentar como fornecer feedback para a organização.
- Como não há documentação anterior para referência, o texto também vai ser escrito do zero.
Semanas 6 a 9 (26 de outubro a 15 de novembro)
- Fase C de documentação
Semana 7 (26 de outubro a 1o de novembro)
- Esta semana, vou apresentar a documentação de um guia de interação com o Índice interlíngue colaborativo (CILI)
- Nesta semana, documentaremos como e por que descontinuar e substituir conceitos.
Semana 8 (2 a 8 de novembro)
- Nesta semana, vou documentar mais informações sobre o CILI e escrever instruções sobre como fazer o download dele 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)
- Documentação fase-D
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, trabalharei nela, incluirei informações adicionais relacionadas ao OMW e verificarei quais outras páginas existentes do OMW precisam ser preenchidas.
- A falta de páginas OMW será melhorada e, sempre que possível, tentarei adicionar recursos visuais a elas.
Semana 11 (23 a 29 de novembro)
- Como os projetos da GWA são sobrepostos, esta semana é reservada para atender a essas necessidades organizacionais conflitantes e outras documentações diversas.
Finalização do projeto e fase de avaliação (30 de novembro a 5 de dezembro)
- Esta semana, trabalharemos na revisão da documentação em busca de erros de digitação e erros.
- Vou escrever meu relatório do projeto.
- Solicitarei que meus mentores revisem o relatório do projeto.
- Vou finalizar e enviar meu relatório do 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 depende da conversa com os mentores. Prefiro uma comunicação regular. Minha sugestão é duas vezes por semana para atualizar e receber feedback sobre o trabalho realizado até agora. No entanto, isso também é flexível, dependendo das preferências deles.
Por que este projeto?
Tenho interesse em linguística, e a ideia de conectar wordnets para todos os idiomas do mundo me intrigou a participar da Global Wordnet Association e contribuir com este projeto. O conceito Open Multilíngue Wordnet é admirável, já que redes de palavras individuais são vinculadas a redes de palavras em outros idiomas, o que as torna mais fáceis de acessar. O Wordnet Multilíngue Open e seus componentes podem ser usados, modificados e compartilhados livremente por qualquer pessoa para qualquer finalidade. Embora a GWA tenha uma ideia sólida e uma nobre intenção, a organização não é muito renomada e é subestimada. Provavelmente, um dos motivos é a documentação superficial e a falta de guias do usuário para ajudar na contribuição e usá-la. Percebi que o projeto Open Multilingual Wordnet é algo com o qual posso contribuir para ajudar a Associação Global Wordnet e a comunidade de código aberto em comum.
Planos futuros:
Após concluir o GSoD 20, continuarei contribuindo para a Global Wordnet Association em outros projetos também. Se tiver a oportunidade, com certeza participarei de qualquer conferência da organização.