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