На этой странице содержится подробная информация о проекте технического написания, принятом для участия в Google Season of Docs.
Краткое описание проекта
- Организация с открытым исходным кодом:
- Глобальная ассоциация Wordnet
- Технический писатель:
- Йойо Ву
- Название проекта:
- Структура Wordnet
- Длина проекта:
- Стандартная продолжительность (3 месяца)
Описание Проекта
Почему этот проект
Как технический писатель по специальности лингвистика, я рад найти такой проект, в котором идея объединения разных языков в единую семантико-концептуальную структуру была применена к реальному бизнесу, такому как Google Translate. Я хотел бы внести свой вклад в документацию этого проекта, чтобы сделать его более удобным для аудитории.
Проблемы
Я просмотрел исходный документ и думаю, что мы можем улучшить его, решив следующие проблемы: Отсутствие раздела «Обзор» в начале, в котором представлены основы wordnet, которые будут полезны новичкам. Хотя все отношения в Wordnet развернуты в едином шаблоне, для некоторых отношений отсутствует необходимая информация, такая как примеры и тесты, которые распространяются на веб-странице Princeton Wordnet, общих рекомендациях EuroWordnet и других ресурсах. Краткое определение и определение, краткий пример и пример не имеют единого шаблона предложений, поскольку краткое определение и краткий пример являются выносками, когда пользователь наводит указатель мыши на конкретное отношение. Определение и пример выполняют основную роль введения отношения, они должны быть структурированы в унифицированные, но отличающиеся модели от своих коротких аналогов. Тесты взяты из EWN, но блок условий следует располагать перед основной частью теста, поскольку пользователи всегда сначала изучают условия, чтобы решить, соответствуют ли их лингвистические данные условиям, а затем проходят тест. Тело теста также не так просто и содержит множество лингвистических сокращений. Содержание раздела «Комментарии» разнообразно, иногда в нем подчеркивается конкретный пункт определения, иногда излагаются детали, специфичные для проекта. Я думаю, нам следует установить стандарт для этого раздела. Перенос информации о конкретных проектах в раздел «Имена конкретных проектов» должен быть более удобным для пользователей. В разделе «Имена, специфичные для проекта» суммируются имена отношений во всех проектах. Этот раздел необходимо просмотреть, поскольку возникают ошибки несоответствия. Необходимо связать Глоссарий терминов непосредственно с документом и добавить все сокращения и термины, которые могут быть незнакомы новичку.
Методические рекомендации
Я также хотел бы обсудить две темы с командой проекта перед составлением документации. Полученное заключение послужит общим руководством для всего проекта.
Об аудитории Вот реальный пример меня самого, хотя я специализируюсь на лингвистике, когда я впервые сталкиваюсь с оригинальным документом, я не знаю, что означает «синсет», именно на веб-странице Принстона Wordnet я нахожу значение слова синсет.
Итак, сначала нам нужно выяснить структуру знаний потенциальной аудитории. Если мы не можем гарантировать, что вся аудитория оснащена соответствующими знаниями, то, по крайней мере, нам нужно добавить раздел «Обзор», связать глоссарий терминов и другие соответствующие ресурсы для руководства. их через Wordnet и связанные с ним проекты. Мы всегда должны помнить об этом предположении на протяжении всего процесса документирования.
О функциях документов. Насколько я понимаю, цель документов по структуре Wordnet — помочь пользователям ознакомиться со всеми типами отношений в Wordnet, а пользователи могут группировать слова в эти отношения на основе предоставленной информации. Однако оригинальные документы больше похожи на выдержки из научных статей. Если цель документации — академическая справка, это нормально, но если она служит руководству для пользователей, тогда должен быть компромисс между академическими кругами и полезностью.
Преимущества
Я могу помочь перевести китайскую версию документации. Имею опыт перевода лингвистических работ с английского на китайский. Я могу помочь с форматированием документов, я знаю основы HTML/CSS и могу помочь улучшить внешний вид веб-страницы документов, например, добавив боковую панель навигации. Я могу помочь нарисовать несколько блок-схем с помощью Visio или Mermaid, если блок-схемы помогут пользователям лучше понять взаимосвязи.
Вехи / Время / Цель
- Неделя 1: Обсудите и согласуйте цель, рабочий процесс и план работы с командой проекта.
- Неделя 2: Составьте план документации и напишите раздел «Обзор».
- Неделя 3 – Неделя 4: Напишите часть «Основные отношения».
- Неделя 5 – Неделя 6: Напишите часть «Отношения между другим и доменом».
- Неделя 7 – Неделя 8: Напишите часть о ролевых отношениях.
- Неделя 9: Напишите оставшиеся три отношения и обновите глоссарий.
- Неделя 10: При необходимости переведите китайскую версию.
- Неделя 11: Пересмотрите формат документов.
- Неделя 12: Заключительная проверка и подведение итогов проекта.