今年,ESLint 首次被 Google Season of Docs (GSoD) 项目接受(这在很大程度上要感谢我们的 赞助商)。ESLint 团队一直高度重视项目的文档质量,我们提出了一个 项目列表,我们认为这些项目可以改进我们的文档。我们通过 GSoD 收到了 20 多份申请,经过长时间的评分和审查申请,我们最终找到了我们的技术作家!
我们很荣幸地介绍 Khawar Latif Khan,2020 年 ESLint GSoD 技术作家。以下是 Khawar 本人介绍的一些情况
我是一名来自巴基斯坦的工程师转型为传播专家,热衷于创作有帮助且易于理解的内容。我在北卡罗来纳州立大学获得了技术与专业传播研究生学位,并获得了富布赖特奖学金。在我攻读电气工程本科期间和之后,我对如何用简单的语言向人们传达复杂的专业知识产生了兴趣,而大多数工程专业课程都没有关注这一领域。这促使我改变专业,成为专业信息创建者和受众之间的桥梁,他们都与相同的内容进行交互,但目标却不同。
Khawar 对 ESLint 感兴趣的原因
尽管我使用开源软件已经有一段时间了,但我对这个术语的熟悉程度还比较新,就像我对代码检查软件的了解一样。当我开始学习 Python(通过 edX)时,我确实想知道微小的错误是如何破坏整个代码的。我认为对代码进行某种测试,识别错误,然后我就了解了“代码检查”这个术语。我还没有很好地使用过代码检查软件,但我相信这在未来会让我的生活变得轻松很多。
与 ESLint 合作不仅可以帮助我追求自己的兴趣,还可以加强我与工程知识和技术背景的联系。我为 ESLint 提出的项目,即重新组织/重写配置文档,将专注于进行全面的内容审核、改进信息架构,并使内容既有用又可重用。我相信,在 ESLint 工作经验丰富的人员的指导下,在协作的环境中,将为 ESLint 的文档增添巨大的价值。
Khawar 提交了一个关于重新组织和重写我们的 配置文档 的提案,目前该文档包含大量信息,但缺乏结构。他的提案包括一个关于解决文档问题的全面计划,分为以下步骤
- 进行全面的内容审核
- 创建信息架构以了解信息的流动
- 改进信息架构以重新组织文档
- 识别内容不同部分之间的链接和引用
- 如有必要,重写/编辑文档的部分内容以满足重新配置的要求
- 确保内容灵活且可重用
该提案包含几页关于每个步骤如何进行以及每个步骤预计需要多长时间的信息。这种详细程度让我们确信 Khawar 了解了项目的目标和所涉及的工作量。
Khawar 的 ESLint 指导老师将是 Kai Cataldo。Kai 是 ESLint 首位获得报酬的专职维护者,他的时间是我们在今年能够参与 GSoD 的原因。(这只是您的 捐赠 如何使项目受益的方式之一。)Kai 将直接与 Khawar 合作,让他快速了解项目,并指导他完成更新配置文档的过程。
我们非常高兴第一次参与 GSoD,并感谢 Khawar 承担了这个项目。希望这不会是 ESLint 项目最后一次能够参与 GSoD,我们期待在未来分享今年项目的结果。