Published under: Release Notes
1 min read
今年，ESLint 首次被接受加入 Google 文档季（GSoD）项目（在很大程度上要感谢我们的赞助商）。ESLint 团队一直非常重视项目的高质量文档，因此我们列出了一个项目列表，我们认为这些项目可以改进我们的文档。通过 GSoD，我们收到了 20 多份申请，在经过大量时间的评分和审核申请后，我们最终找到了我们的技术文档作者！
🌐 This year, ESLint was accepted into the Google Season of Docs (GSoD) program for the first time (thanks, in large part, to our sponsors). The ESLint team has always placed a high value on quality documentation for the project and we came up with a list of projects that we thought could improve our documentation. We received more than 20 applications through GSoD, and after a lot of time grading and reviewing applications, we finally ended up with our technical writer!
我们很高兴介绍 Khawar Latif Khan，2020 年 ESLint GSoD 技术作家。以下是关于 Khawar 的一些信息，直接来自他本人：
🌐 It’s our pleasure to introduce Khawar Latif Khan, the 2020 ESLint GSoD technical writer. Here’s a little about Khawar, straight from him:
我是一名来自巴基斯坦的工程师，后转为传播专家，热衷于创作有用且易于理解的内容。我拥有北卡罗来纳州立大学的技术与专业传播研究生学位，该学位由富布赖特奖学金资助。在攻读电气工程本科学位期间及之后，我开始对将复杂的技术知识以简单方式传达给公众产生兴趣，而这是大多数工程项目没有重视的字段。这促使我转变专业，成为技术信息的创作者与受众之间的桥梁，他们可能接触同样的内容，但目标不同。
Khawar 对 ESLint 感兴趣的原因：
🌐 What interested Khawar in ESLint:
Despite the fact that I have been using open-source software for quite some time, my familiarity with the term is fairly new, similar to my knowledge of linting software. When I started learning Python (through edX), I did wonder how tiny errors can mess the whole code up. I thought it would be nice to have your codes tested, somehow, and get your errors identified, and then I came to know about the term “linting.” I haven’t aptly used linting software yet but I’m sure these will make my life a lot easier in the days to come.
Working with ESLint will not only help me pursue my interests but also strengthen my connection with my engineering knowledge and technical background. My proposed project for ESLint, to reorganize/rewrite the configuration documentation, will focus on conducting a comprehensive content audit, improving the information architecture, and to make the content both useful and reusable. With the guidance of experienced personnel working at ESLint and a collaborative environment, I believe, will add great value to the documentation of ESLint.
Khawar 提交了一份关于重组和重写我们的配置文档的提案，目前这些文档包含了大量信息但缺乏明确的结构。他的提案包含了一个全面的计划来处理文档，并分为以下步骤：
🌐 Khawar submitted a proposal for reorganizing and rewriting our configuration documentation, which right now contains a lot of information without a lot of structure. His proposal included a comprehensive plan for addressing the documentation, separated into these steps:
- 进行全面的内容审查
- 创建信息架构以理解信息流
- 改进信息架构以重新组织文档
- 识别内容不同部分之间的链接和参考
- 如有必要，重写/编辑文档部分内容以满足重新配置的要求
- 确保内容具有灵活性和可重用性
该提案包含了与每个步骤将如何进展以及每个步骤预计需要多长时间相关的多页信息。这种详细程度让我们感到放心，认为Khawar理解项目的目标以及所涉及的工作量。
🌐 This proposal contained pages of information related to how each step will progress and how long each step is anticipated to take. This level of detail made us feel comfortable that Khawar understood the project’s goals and the amount of work involved.
Khawar 的 ESLint 导师将是 Kai Cataldo。Kai 是 ESLint 的第一位全职付费维护者，他能够腾出时间正是让我们今年能够参与 GSoD 的原因之一。（这只是你的捐赠惠及项目的众多方式之一。）Kai 将直接与 Khawar 一起工作，使他熟悉项目，并指导他完成更新配置文档的过程。
🌐 Khawar’s ESLint mentor will be Kai Cataldo. Kai is ESLint’s first paid dedicated maintainer, and having his time available is what allowed us to participate in GSoD this year. (Just one of the ways in which your donations benefit the project.) Kai will work directly with Khawar to get him up to speed on the project and guide him through the process of updating the configuration documentation.
我们非常高兴首次参与 GSoD，并且感谢 Khawar 接手这个项目。希望这不会是 ESLint 项目最后一次参与 GSoD，我们期待未来分享今年项目的成果。
🌐 We are very excited to be participating in GSoD for the first time and grateful to Khawar for taking this project on. Hopefully, this won’t be the last time the ESLint project is able to participate in GSoD and we look forward to sharing the results of this year’s project in the future.
