На этой странице содержится подробная информация о проекте технического написания, принятом для участия в Google Season of Docs.
Краткое описание проекта
- Организация с открытым исходным кодом:
- Глобальная сеть Wordnet
- Технический писатель:
- Кумар
- Название проекта:
- Открытая многоязычная сеть Wordnet (OMW)
- Длина проекта:
- Стандартная продолжительность (3 месяца)
Описание проекта
Запрос проекта:
Я связался с наставниками Глобальной ассоциации Wordnet и отправил запрос на включение, который был ими положительно рассмотрен. Если бы у меня была возможность, я мог бы тратить на этот проект 40 часов (или больше) в неделю. Я хорошо владею Python, Git, HTML, C++, Java и C. Я двуязычен и могу свободно говорить на английском и хинди, я выучил французский в школе и также немного знаю немецкий. Я с большим желанием и энтузиазмом внести свой вклад в Глобальную ассоциацию Wordnet через этот проект, если мне представится возможность, я буду работать с максимальной самоотдачей.
Текущее состояние:
Текущая документация Open Multilingual Wordnet поверхностна, а существующие руководства пользователя неполны, в них отсутствуют содержание, графика, примеры и подробные инструкции. Не существует руководства пользователя, которое могло бы помочь кому-то искать в сети Wordnet, как читать возвращенные страницы, как устанавливать и как оставлять отзывы. Имеется некоторая документация по созданию новой сети Wordnet, но эта документация не является полной и ясной, чтобы помочь кому-либо присоединиться к открытой многоязычной сети Wordnet. Не существует документации о том, как взаимодействовать с Совместным межъязыковым индексом (CILI), есть вводная страница CILI, на которой отсутствует информация о том, почему и как отвергать и заменять концепции, оценивая новых кандидатов. В целом текущей документации не хватает содержания, ясности, примеров и визуальных эффектов для помощи.
План:
Я планировал реализовать этот проект в четыре этапа. На этапе А я задокументирую руководство для тех, кто создает новую сеть слов. На этом этапе я расскажу о том, как создать хорошо отформатированную сеть слов, как загрузить ее и как понять обратную связь. На следующем этапе Б я задокументирую руководство для тех, кто ищет в сети Wordnet (или семействе сетей Wordnet), в этой документации я расскажу, как читать возвращенные страницы, как загружать их и как оставлять отзывы. На этапе C я задокументирую руководство по взаимодействию с Совместным межъязыковым индексом, порядок отказа от использования и замены концепций, а также оценку новых кандидатов, которые будут задокументированы на этапе C. На этапе D я заполню документацию Open Multilingual Wordnet, улучшить существующую документацию этого проекта, кроме документации, представленной на этапах A, B и C. Поскольку между проектами GWA существует дублирование, этап D также будет посвящен организационным требованиям. Я запланировал выделить недели 1, 2 и 3 для фазы А, недели 4, 5 и 6 будут отведены для фазы Б, недели 7, 8 и 9 для фазы С и недели 10 и 11 для фазы D.
Цели проекта:
1) Анализ существующей документации и определение того, какой раздел требует доработки.
2) Реконструкция структуры существующей документации.
3) Документирование руководства для тех, кто создает новую сеть Wordnet.
4) Документирование руководства для тех, кто ищет в сети Wordnet.
5) Документирование руководства по взаимодействию с Совместным межъязыковым указателем.
6) Добавление примеров и наглядности в документацию.
7) Заполнение существующих страниц, документация на которых кажется поверхностной.
Хронология:
Фаза объединения сообществ: 17 августа – 13 сентября.
- В этот период я буду взаимодействовать с сообществом и лучше его узнаю.
- Настройте канал связи.
- Настройте время общения.
- Уточните цели и определите ожидания обеих сторон.
Этап разработки документа (14 сентября – 30 ноября)
- Я буду тесно сотрудничать со своими наставниками и завершу свой проект на этом этапе в соответствии с еженедельными планами.
- Заполните любой опрос от администраторов программы Google.
Неделя 1–3 (14–27 сентября)
- Документация, этап А
Неделя 1 (14-20 сентября)
- Начнется подготовка документации для руководства для тех, кто создает новую сеть Wordnet.
- На этой неделе я буду писать документацию о том, как создать хорошо отформатированную сеть Wordnet.
- Будут задокументированы четкие инструкции по преобразованию пользовательской сети Wordnet в общедоступное определение типа документа Wordnet LMF (DTD).
- В нем также будут рассмотрены инструменты преобразования.
Неделя 2 (21–27 сентября)
- На этой неделе я напишу документацию о том, как загрузить свою сеть Wordnet (после преобразования в определение типа документа Wordnet LMF) в OMW.
- Существующая документация неглубока (но точна). Я дополню ее и добавлю примеры в документацию.
Неделя 3 (28 сентября – 4 октября)
- Эта неделя будет использована для документирования того, как разобраться в обратной связи.
- Эту документацию необходимо писать с нуля, так как существующей документации по этой теме не существует.
Недели 4–6 (5–25 октября)
- Документация, этап B
Неделя 4 (5–11 октября)
- На этой неделе я начну документировать руководство для тех, кто ищет в сети wordnet (или семействе сетей wordnet).
- На этой неделе я напишу документацию о том, как читать возвращенные страницы.
Неделя 5 (12–18 октября)
- На этой неделе я опишу, как скачать.
- Для этого нет существующей документации, ее необходимо писать с нуля.
6-я неделя (19–25 октября)
- На этой неделе я опишу, как предоставить обратную связь организации.
- Поскольку предыдущей документации, на которую можно было бы взять ссылку, нет, она также будет написана с нуля.
Недели 6–9 (26 октября – 15 ноября)
- Документация, этап C
7-я неделя (26 октября – 1 ноября)
- На этой неделе я начну документировать руководство по взаимодействию с Collaborative Interlingual Index (CILI).
- На этой неделе я расскажу, как и почему следует отвергать и заменять концепции.
8-я неделя (2–8 ноября)
- На этой неделе я буду документировать дополнительную информацию о CILI и напишу инструкции о том, как загрузить CILI и выполнить организационные требования к документации CILI. Эту документацию необходимо писать с нуля.
Недели 9–11 (9–29 ноября)
- Фаза документации-D
9-я неделя (9–15 ноября)
- OMW 2.0 теперь будет разрабатываться в соответствии с потребностями организации.
Неделя 10 (16–22 ноября)
- Документация домашней страницы Open Multilingual Wordnet (OMW) показалась мне поверхностной, на этой неделе я буду работать над ней и добавлю дополнительную информацию, связанную с OMW, и посмотрю, какие еще существующие страницы OMW необходимо заполнить.
- Недостающие страницы OMW будут дорабатываться и по мере возможности я буду стараться добавлять в них визуальные эффекты.
Неделя 11 (23–29 ноября)
- Поскольку проекты GWA частично совпадают, эта неделя отведена для выполнения этих частично совпадающих организационных потребностей и другой различной документации.
Этап завершения и оценки проекта (30 ноября – 5 декабря)
- Эта неделя будет потрачена на вычитку документации на предмет опечаток и ошибок.
- Я напишу отчет о своем проекте.
- Я попрошу своих наставников просмотреть отчет о моем проекте.
- Я доработаю и представлю отчет о проекте.
- Я напишу и представлю оценку своим наставникам и своему опыту работы в Season of Docs.
Коммуникация:
Частота контактов будет зависеть от обсуждения с наставниками. Я предпочитаю регулярное общение — я предлагаю дважды в неделю предоставлять обновленную информацию и получать отзывы о проделанной на данный момент работе. Однако это также гибко в зависимости от их предпочтений.
Почему этот проект?
У меня есть интерес к лингвистике, и идея объединить сети Wordnet для всех языков мира побудила меня присоединиться к Global Wordnet Association и внести свой вклад в этот проект. Концепция открытой многоязычной сети слов достойна восхищения, когда отдельные сети слов связаны с сетями слов на других языках, что делает эти сети слов более доступными. Открытая многоязычная сеть Wordnet и ее компоненты могут свободно использоваться, изменяться и распространяться кем угодно для любых целей. Хотя у GWA есть твердая идея и благородные намерения, организация малоизвестна и недооценена. Вероятно, одной из причин является неглубокая документация и отсутствие руководств пользователя, которые помогли бы внести в нее вклад и использовать ее. Я понял, что проект Open Multilingual Wordnet — это то, в чем я могу внести свой вклад, чтобы помочь Глобальной ассоциации Wordnet и сообществу открытого исходного кода в целом.
Планы на будущее:
После завершения GSoD 20 я буду продолжать вносить вклад в Глобальную ассоциацию Wordnet и в других проектах. Если будет возможность, я обязательно приду на любую конференцию организации.