Esta página contiene los detalles de un proyecto de redacción técnica aceptado para la GDOC Season of Docs.
Resumen del proyecto
- Organización de código abierto:
- Global Wordnet
- Redactor técnico:
- Kumar
- Nombre del proyecto:
- Open Multilingual Wordnet (OMW)
- Duración del proyecto:
- Duración estándar (3 meses)
Project description
Solicitud de proyecto:
Me comuniqué con mentores de Global Wordnet Association y envié una solicitud de incorporación de cambios que recibieron una opinión favorable de ellos. Si tengo la oportunidad, puedo dedicarle 40 horas (o más) a la semana a este proyecto. Tengo un buen conocimiento de Python, Git, HTML, C++, Java y C. Soy bilingüe y puedo hablar inglés y hindi con fluidez. Aprendí francés en la escuela y también sé un poco de alemán. Me entusiasma contribuir a la Asociación Global de WordNet a través de este proyecto. Si me dan la oportunidad, trabajaré con la máxima dedicación.
Estado actual:
La documentación actual de Open Multilingual Wordnet es superficial y las guías de usuario existentes no tienen contenido, gráficos, ejemplos ni instrucciones explícitas. No hay una guía del usuario para ayudar a alguien que busca en WordNet, cómo leer las páginas que se muestran, cómo instalarlo o cómo enviar comentarios. Hay documentación sobre cómo contribuir con un nuevo WordNet, pero no es completa ni clara para guiar a alguien sobre cómo unirse al Open Multilingual Wordnet. No hay documentación sobre cómo interactuar con el Índice Interlingüe Colaborativo (CILI). Hay una página de introducción a CILI, en la que no hay información como por qué y cómo dar de baja y reemplazar conceptos, para juzgar a los nuevos candidatos. En general, la documentación actual carece de contenido, claridad, ejemplos y recursos visuales para brindar asistencia.
Plan:
Planeé ejecutar este proyecto en cuatro fases. En la fase A, documentaré una guía para alguien que aporte un nuevo WordNet. En esta fase, se abordará cómo crear un WordNet con un formato correcto, cómo subirlo y cómo interpretar los comentarios. En la siguiente fase B, documentaré una guía para alguien que busque en el WordNet (o la familia de WordNets). En esa documentación, explicaré cómo leer las páginas que se muestran, cómo descargarlas y cómo enviar comentarios. En la fase C, documentaré una guía para interactuar con el Índice interlingüístico colaborativo, cómo dar de baja y reemplazar conceptos, y cómo juzgar a los candidatos nuevos. En la fase D, propagaré la documentación de Open Multilingual Wordnet y mejoraré la documentación existente de este proyecto, además de la que se abarcó en las fases A, B y C. Como hay superposición entre los proyectos de GWA, la fase D también se dedicará a los requisitos organizativos. Planeé asignar las semanas 1,2 y 3 para la fase A, las semanas 4,5 y 6 para la fase B, las semanas 7,8 y 9 para la fase C y las semanas 10 y 11 para la fase D.
Objetivos del proyecto:
1) Analizar la documentación existente y determinar qué sección requiere mejoras.
2) Reconstrucción de la estructura de la documentación existente.
3) Documentar una guía para alguien que agregue un nuevo WordNet
4) Documentar una guía para alguien que busque en WordNet
5) Cómo documentar una guía para interactuar con el índice interlingüe colaborativo.
6) Agregar ejemplos y elementos visuales a la documentación
7) Completar las páginas existentes en las que la documentación parece superficial.
Cronograma:
Fase de vinculación de la comunidad: del 17 de agosto al 13 de septiembre
- Durante este período, interactuaré con la comunidad y la conoceré mejor.
- Configura un canal de comunicación.
- Establece un horario para la comunicación.
- Define mejor los objetivos y establece expectativas para ambas partes.
Fase de desarrollo de documentos (del 14 de septiembre al 30 de noviembre)
- Trabajaré en estrecha colaboración con mis mentores y completaré mi proyecto en esta fase según los planes semanales.
- Completa cualquier encuesta de los administradores del programa de Google.
Semanas 1 a 3 (del 14 al 27 de septiembre)
- Fase de documentación-A
Semana 1 (del 14 al 20 de septiembre)
- Comenzará la documentación de una guía para quienes quieran contribuir con un nuevo WordNet.
- Esta semana les explicaré cómo crear una red de palabras con formato adecuado.
- Se documentarán instrucciones claras para convertir el WordNet del usuario en la definición de tipo de documento (DTD) pública de WordNet LMF.
- También se abordarán las herramientas de conversión.
Semana 2 (del 21 al 27 de septiembre)
- Esta semana, haré la documentación sobre cómo subir un WordNet (después de convertirlo a la definición de tipo de documento LMF de WordNet) a OMW.
- La documentación existente es superficial (pero precisa). La propagaré y agregaré ejemplos a la documentación.
Semana 3 (del 28 de septiembre al 4 de octubre)
- Esta semana se usará para documentar cómo interpretar los comentarios.
- Esta documentación debe escribirse desde cero, ya que no hay documentación existente sobre este tema.
Semanas 4 a 6 (del 5 al 25 de octubre)
- Fase de documentación B
Semana 4 (del 5 al 11 de octubre)
- Esta semana comenzaré a documentar una guía para alguien que busque en el WordNet (o la familia de WordNet).
- Esta semana, escribiré documentación para leer las páginas que se devuelven.
Semana 5 (del 12 al 18 de octubre)
- Esta semana, documentaré cómo descargar.
- No hay documentación existente para esto, se debe escribir desde cero.
Semana 6 (del 19 al 25 de octubre)
- Esta semana documentaré cómo enviar comentarios a la organización.
- Como no hay documentación anterior a la que hacer referencia, esto también se escribirá desde cero.
Semanas 6 a 9 (del 26 de octubre al 15 de noviembre)
- Fase C de la documentación
Semana 7 (del 26 de octubre al 1 de noviembre)
- Esta semana comenzaré la documentación de una guía para interactuar con el Índice interlingüístico colaborativo (CILI).
- Esta semana, documentaré cómo y por qué dar de baja y reemplazar conceptos.
Semana 8 (del 2 al 8 de noviembre)
- Esta semana, documentaré información adicional sobre CILI y escribiré instrucciones para descargar CILI y cumplir con los requisitos organizativos en la documentación de CILI. Esta documentación debe escribirse desde cero.
Semana del 9 al 11 (del 9 al 29 de noviembre)
- Fase D de la documentación
Semana 9 (del 9 al 15 de noviembre)
- La OMW 2.0 se desarrollará ahora, según las necesidades de la organización.
Semana 10 (del 16 al 22 de noviembre)
- La documentación de la página principal de Open Multilingual Wordnet (OMW) parecía superficial. Esta semana trabajaré en ella y agregaré la información adicional relacionada con OMW. También veré qué otras páginas existentes de OMW deben propagarse.
- Se mejorarán las páginas de OMW que faltan y, siempre que sea posible, intentaré agregar imágenes en ellas.
Semana 11 (del 23 al 29 de noviembre)
- Como hay superposición en los proyectos de GWA, esta semana se reserva para satisfacer estas necesidades organizativas superpuestas y otra documentación miscelánea.
Fase de finalización y evaluación del proyecto (del 30 de noviembre al 5 de diciembre)
- Esta semana, revisarás la documentación en busca de errores tipográficos y otros errores.
- Escribiré mi informe del proyecto.
- Les pediré a mis mentores que revisen el informe de mi proyecto.
- Finalizaré y enviaré mi informe de proyecto.
- Escribiré y enviaré una evaluación de mis mentores y mi experiencia en la Temporada de Documentos.
Comunicación:
La frecuencia del contacto dependerá de una conversación con los mentores. Prefiero una comunicación periódica. Mi sugerencia es dos veces por semana para brindar actualizaciones y recibir comentarios sobre el trabajo realizado hasta el momento. Sin embargo, esto también es flexible según sus preferencias.
¿Por qué este proyecto?
Me interesa la lingüística y la idea de conectar los grafos de palabras de todos los idiomas del mundo me intrigó para unirme a la Global Wordnet Association y contribuir a este proyecto. El concepto de Open Multilingual Wordnet es admirable, ya que los grafos de etimología individuales están vinculados a grafos de etimología en otros idiomas, lo que facilita el acceso a estos grafos. Cualquier persona puede usar, modificar y compartir Open Multilingual Wordnet y sus componentes de forma gratuita y con cualquier fin. Aunque GWA tiene una idea sólida y una intención noble, la organización no es muy reconocida y está subestimada. Es probable que uno de los motivos sea la documentación superficial y la falta de guías para el usuario que ayuden a contribuir con ella y a usarla. Consideré que el proyecto Open Multilingual Wordnet es algo en lo que puedo contribuir para ayudar a la Global Wordnet Association y a la comunidad de código abierto en común.
Planes para el futuro:
Después de completar GSoD 20, seguiré contribuyendo a la Global Wordnet Association en otros proyectos. Si tengo la oportunidad, sin dudas asistiré a alguna conferencia de la organización.