本页面包含 Google 文档季接受的技术写作项目的详细信息。
项目摘要
- 开源组织:
- 全球 Wordnet
- 技术文档工程师:
- Kumar
- 项目名称:
- 开放式多语言 Wordnet (OMW)
- 项目时长:
- 标准时长(3 个月)
Project description
项目请求:
我已与 Global Wordnet Association 导师联系,并提交了一份拉取请求,该请求已获得他们的积极审核。 如果有机会,我可以每周花 40 小时(或更多时间)来完成此项目。 我精通 Python、Git、HTML、C++、Java 和 C。我精通英语和印地语,在学校学过法语,还会一点德语。我非常热衷于通过此项目为全球 Wordnet 协会做出贡献,如果有机会,我会全力以赴。
当前状态:
当前的 Open Multilingual Wordnet 文档内容浅显、不完整,现有用户指南缺乏内容、图形、示例和明确的说明。没有用户指南来帮助用户搜索 WordNet、如何阅读返回的网页、如何安装、如何提供反馈。关于贡献新 WordNet 的文档虽然有,但这些文档既不完整,也不清晰地指导用户如何加入开放式多语言 WordNet。没有关于如何与协作式跨语言索引 (CILI) 交互的文档,虽然有 CILI 简介页面,但其中缺少为何以及如何弃用和替换概念、评判新候选概念等信息。总体而言,当前文档缺乏内容、清晰度、示例和视觉元素,无法提供帮助。
方案:
我计划分四个阶段执行此项目。在第 A 阶段,我将为贡献新 WordNet 的用户编写一份指南,其中将介绍如何创建格式良好的 WordNet、如何上传 WordNet,以及如何解读反馈。在下一个阶段 B 中,我将为搜索 WordNet(或 WordNet 家族)的用户编写一份指南,在该文档中,我将介绍如何阅读返回的网页、如何下载以及如何提供反馈。在第 C 阶段,我将编写有关如何与协作式跨语言索引交互的指南,以及如何弃用和替换概念,并在第 C 阶段记录评判新候选项的方法。在第 D 阶段,我将填充开放式多语言 Wordnet 的文档,改进此项目的现有文档(除了第 A、B 和 C 阶段涵盖的文档)。由于 GWA 的项目之间存在重叠,因此第 D 阶段还将专门用于满足组织要求。我计划将第 1、2 和 3 周分配给第 A 阶段,第 4、5 和 6 周分配给第 B 阶段,第 7、8 和 9 周分配给第 C 阶段,第 10 和 11 周分配给第 D 阶段。
项目目标:
1) 分析现有文档,并确定哪部分需要改进。
2) 重构现有文档的结构。
3) 为贡献新 WordNet 的人员编写指南。
4) 为搜索 WordNet 的用户编写指南。
5) 编制协作国际索引 (Collaborative Interlingual Index) 交互指南。
6) 在文档中添加了示例和图形。
7) 填充文档似乎不够详尽的现有页面。
时间线:
社区互动阶段:8 月 17 日至 9 月 13 日。
- 在此期间,我将与社区成员互动,更深入地了解社区。
- 设置沟通渠道。
- 设置通信时间。
- 优化目标,并为双方设定预期。
文档开发阶段(9 月 14 日至 11 月 30 日)
- 我将与导师密切合作,并在此阶段根据每周计划完成项目。
- 填写 Google 计划管理员发送的任何调查问卷。
第 1-3 周(9 月 14 日至 27 日)
- 文档编写阶段 - A
第 1 周(9 月 14 日至 20 日)
- 我们将开始编写面向贡献新 WordNet 的用户的指南文档。
- 本周,我将编写文档,介绍如何创建格式良好的 WordNet。
- 我们将提供有关将用户的 WordNet 转换为公共 WordNet LMF 文档类型定义 (DTD) 的明确说明。
- 其中还将介绍转化工具。
第 2 周(9 月 21 日至 27 日)
- 本周,我会编写相关文档,介绍如何(在转换为 Wordnet LMF 文档类型定义后)将用户的 wordnet 上传到 OMW。
- 现有文档的内容浅层(但准确),我将填充该文档并在文档中添加示例。
第 3 周(9 月 28 日至 10 月 4 日)
- 本周将用于记录如何解读反馈。
- 由于没有现有关于此主题的文档,因此必须从头开始撰写此文档。
第 4-6 周(10 月 5 日至 25 日)
- 文档编写阶段 - B
第 4 周(10 月 5 日至 11 日)
- 本周,我将开始编写一份指南,供搜索 WordNet(或 WordNet 家族)的用户参考。
- 本周,我将编写有关如何读取返回的网页的文档。
第 5 周(10 月 12 日至 18 日)
- 本周,我将介绍如何下载。
- 目前没有关于此的现有文档,因此需要从头开始编写。
第 6 周(10 月 19 日至 25 日)
- 本周,我将记录如何向组织提供反馈。
- 由于没有可供参考的先前文档,因此这也是从头开始编写。
第 6-9 周(10 月 26 日至 11 月 15 日)
- 文档编写阶段-C
第 7 周(10 月 26 日至 11 月 1 日)
- 本周,我将开始编写有关如何与协作式跨语言索引 (CILI) 互动的指南文档
- 本周,我将记录如何以及为什么要废弃和替换概念。
第 8 周(11 月 2 日至 8 日)
- 本周,我将记录有关 CILI 的更多信息,并编写有关如何下载 CILI 以及如何满足 CILI 文档的组织要求的说明。此文档需要从头开始编写。
第 9-11 周(11 月 9 日至 29 日)
- 文档阶段 D
第 9 周(11 月 9 日至 15 日)
- 根据组织的需求,现在将开发 OMW 2.0。
第 10 周(11 月 16 日至 22 日)
- Open Multilingual Wordnet (OMW) 首页的文档似乎不够详尽,我会在本周对其进行完善,并添加与 OMW 相关的其他信息,同时查看哪些其他 OMW 现有页面需要填充。
- 我会改进缺少 OMW 页面的问题,并尽可能在其中添加视觉内容。
第 11 周(11 月 23 日至 29 日)
- 由于 GWA 的项目存在重叠,因此本周将用于满足这些重叠的组织需求以及其他杂项文档。
项目最终确定和评估阶段(11 月 30 日至 12 月 5 日)
- 本周,我们将校对文档,检查是否有拼写错误和其他错误。
- 我会撰写项目报告。
- 我会请导师审核我的项目报告。
- 我会最终确定并提交项目报告。
- 我将撰写并提交对导师和文档季体验的评估。
通信:
联系频率取决于与导师的讨论结果。我更喜欢定期沟通 - 我的建议是每周两次,分享最新进展并接收对迄今为止所做工作的反馈。不过,这也取决于他们的偏好设置。
为什么要启动此项目?
我对语言学很感兴趣,因此当我了解到将世界所有语言的 WordNet 关联起来的想法后,便决定加入全球 WordNet 协会,为此项目做出贡献。开放式多语言 WordNet 的概念非常值得称赞,其中各个 WordNet 与其他语言的 WordNet 相关联,这使得这些 WordNet 更易于访问。任何人都可以出于任何目的自由使用、修改和共享开放式多语言 Wordnet 及其组件。虽然 GWA 的理念和意图很坚定,但该组织并不太出名,被低估了。原因之一可能是文档内容不够丰富,缺少用户指南来帮助用户贡献和使用该模型。我觉得 Open Multilingual Wordnet 项目能为全球 Wordnet 协会和共同的开源社区做出贡献。
未来计划:
完成 2020 年 GSoD 后,我还将继续在其他项目中为全球 Wordnet 协会做出贡献。如果有机会,我一定会参加该组织举办的任何会议。