本页面包含 Google 文档季接受的技术写作项目的详细信息。
项目摘要
- 开源组织：
- 全球 Wordnet 协会
- 技术文档工程师：
- Yoyo Wu
- 项目名称：
- Wordnet 结构
- 项目时长：
- 标准时长（3 个月）
Project description
本次活动的初衷
作为一名主修语言学的技术文案撰写者，我很高兴发现这样一个项目，它通过统一的语义概念框架将不同的语言联系在一起，并已应用于 Google 翻译等实际业务。我想为此项目的文档做出贡献，让其对观众更友好。
问题
我已阅读原始文档，认为我们可以通过解决以下问题来改进文档： 文档开头缺少介绍 WordNet 基础知识的“概览”部分，这对新手很有用。 虽然 WordNet 中的所有关系都是采用统一的模板发布的，但有些关系缺少示例和测试等必要信息，这些信息分布在 Princeton WordNet 网页、EuroWordnet 一般准则和其他资源中。 “简短定义”和“定义”“简短示例”和“示例”缺少统一的句子句式，因为“简短定义”和“简短示例”是用户将鼠标悬停在特定关系上时的标注，而“定义”和“示例”发挥着介绍关系的主要作用，它们的结构应采用与对应的简短格式统一但不同的模式。 测试来自 EWN，但条件块应放在主要测试正文之前，因为用户总是先查看条件，以确定其语言数据是否符合条件，然后再参加测试。测试正文也并不简单，其中包含许多语言缩写。“备注”部分的内容多种多样，有时强调定义的某个特定要点，有时说明项目专用详细信息。我认为我们应该为此部分设置一个标准，将特定项目的相关信息移至“项目专用名称”部分，这样对用户来说会更方便。 “项目专用名称”部分会汇总所有项目中的关联名称，由于出现不匹配错误，因此需要检查此部分。 需要将术语表直接链接到文档，并添加新手可能不熟悉的所有缩写词和术语。
指南
在起草文档之前，我还想与项目团队讨论以下两个主题，所得结论将作为整个项目的一般准则。
受众群体简介 下面是我自己的一个真实例子，虽然我是语言学专业的学生，但当我第一次看到原始文档时，我不知道“synset”是什么意思，直到我在普林斯顿 Wordnet 网页上找到了 synset 的含义。
因此，首先我们需要弄清楚潜在受众群体的知识结构，如果我们不能确保所有受众群体都具备相关知识，那么至少需要添加一个“概览”部分、链接术语词汇表和其他相关资源，引导他们完成 WordNet 及其相关项目。我们应在整个记录过程中始终牢记这一假设，
关于文档的功能 据我所知，Wordnet 结构文档的目标是帮助用户熟悉 wordnet 中的所有关系类型，并且用户可以根据提供的信息将字词分组到这些关系中。不过，原始文档更像是学术论文的摘要。如果文档的用途是作为学术参考，那就没问题，但如果其目的是指导用户，则必须在学术性和实用性之间做出权衡。
优势
我可以帮助翻译文档的中文版本。我有将语言学论文从英语翻译成中文的经验。 我可以帮助设置文档格式，我了解 HTML/CSS 的基础知识，可以帮助优化文档网页的外观，例如添加侧边导航栏。 如果 Visio 或 Mermaid 流程图有助于用户更好地理解两者之间的关系，我就可以帮忙绘制流程图。
里程碑 / 时间 / 目标
- 第 1 周：与项目团队讨论并确定目标、工作流和工作计划。
- 第 2 周：确定文档大纲，并撰写“概览”部分。
- 第 3 周 - 第 4 周：编写构成关系部分。
- 第 5 周至第 6 周：编写“其他”和“网域关系”部分。
- 第 7 周至第 8 周：编写“角色关系”部分。
- 第 9 周：编写其余三个关系并更新术语表。
- 第 10 周：根据需要翻译中文版本。
- 第 11 周：修改文档的格式。
- 第 12 周：对本项目进行最终检查和总结。