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 Association
- Redactor técnico:
- Yoyo Wu
- Nombre del proyecto:
- Estructura de WordNet
- Duración del proyecto:
- Duración estándar (3 meses)
Project description
Por qué este proyecto
Como escritor técnico con especialización en Lingüística, me complace encontrar un proyecto de este tipo, con la idea de vincular diferentes idiomas con un marco conceptual y semántico unificado, y que se aplicó a empresas del mundo real, como Google Traductor. Me gustaría contribuir con los documentos de este proyecto para que el público lo encuentre más fácil de usar.
Problemas
Revisé el documento original y creo que podemos mejorarlo resolviendo los siguientes problemas: Falta de una sección Descripción general al comienzo para presentar los conceptos básicos de wordnet, que será útil para los principiantes. Aunque todas las relaciones del WordNet se lanzan en una plantilla unificada, a algunas les falta la información necesaria, como ejemplos y pruebas, que se distribuye en la página web de Princeton WordNet, los lineamientos generales de EuroWordNet y otros recursos. La definición breve y la definición, el ejemplo breve y el ejemplo carecen de un patrón de oraciones unificado, ya que la definición breve y el ejemplo breve son los textos destacados cuando el mouse del usuario se coloca sobre la relación en particular, la definición y el ejemplo tienen el rol principal de presentar la relación, por lo que deben estructurarse en patrones unificados, pero diferentes de sus contrapartes breves. Las pruebas son de EWN, pero el bloque de condiciones debe colocarse por delante del cuerpo de la prueba principal, ya que los usuarios siempre mirarán las condiciones primero para decidir si sus datos lingüísticos coinciden con las condiciones y, luego, para realizar la prueba. El cuerpo de la prueba tampoco es tan sencillo, ya que tiene muchos acrónimos lingüísticos. El contenido de la sección de comentarios está diversificado. A veces, hace hincapié en un punto particular de la definición y otras veces indica detalles específicos del proyecto. Creo que deberíamos establecer un estándar para esta sección. Mover la información sobre proyectos específicos a la sección Nombres específicos del proyecto debería ser más conveniente para los usuarios. En la sección Nombres específicos del proyecto, se resume el nombre de la relación en todos los proyectos. Esta sección debe revisarse, ya que se producen errores de discrepancia. Es necesario vincular el Glosario de términos directamente al documento y agregar todos los acrónimos y términos que podrían no ser familiares para los principiantes.
Lineamientos
También me gustaría debatir a continuación dos temas con el equipo del proyecto antes de redactar los documentos. La conclusión recibida servirá como pautas generales para todo el proyecto.
Acerca del público Este es un ejemplo real de mí mismo. Aunque soy especialista en idiomas, cuando me encuentro por primera vez con el documento original, no sé qué significa "synset". Es en la página web de Princeton Wordnet que encuentro el significado de "synset".
Por lo tanto, al principio debemos determinar la estructura de conocimiento del público potencial. Si no podemos asegurarnos de que todo el público esté equipado con el conocimiento relevante, entonces al menos debemos agregar una sección de Descripción general, vincular el Glosario de términos y otros recursos relacionados para guiarlos a través de Wordnet y sus proyectos relacionados. Siempre debemos tener en cuenta esta suposición durante todo el proceso de documentación.
Acerca de la función de los documentos Según mis conocimientos, el objetivo de los documentos de estructura de wordnet es ayudar a los usuarios a familiarizarse con todos los tipos de relaciones en wordnet, y los usuarios pueden agrupar palabras en esas relaciones según la información proporcionada. Sin embargo, los documentos originales se parecen más a extractos de artículos académicos. Si el propósito de los documentos es servir de referencia académica, está bien, pero si su objetivo es guiar a los usuarios, debe haber compensaciones entre la academia y la utilidad.
Beneficios
Puedo ayudarte a traducir la versión en chino de los documentos. Tengo experiencia en la traducción de artículos lingüísticos del inglés al chino. Puedo ayudar a dar formato a los documentos, conozco los conceptos básicos de HTML/CSS y puedo ayudar a mejorar el aspecto de la página web de los documentos, como agregar una barra de navegación lateral. Puedo ayudarte a dibujar algunos diagramas de flujo con Visio o Mermaid si estos pueden ayudar a los usuarios a comprender mejor las relaciones.
Hitos / tiempo / objetivo
- Semana 1: analizar y determinar el objetivo, el flujo de trabajo y el plan de trabajo con el equipo del proyecto.
- Semana 2: Define el esquema de los documentos y escribe la sección Descripción general.
- Semana 3 a 4: Escribe la parte de relaciones constitutivas.
- Semana 5 a Semana 6: Escribe la parte Relaciones entre los otros y el dominio.
- Semana 7 a 8: Escribe la parte de relaciones de roles.
- Semana 9: Escribe las tres relaciones restantes y actualiza el glosario.
- Semana 10: Si es necesario, traduce la versión en chino.
- Semana 11: Revisa el formato de los documentos.
- Semana 12: Verificación final y resumen de este proyecto.