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