Skip to main content

Google 文档季

· 5 min read

Electron 很荣幸能够参与 Google 第二届“文档季”计划,该计划将来自开源组织的导师与技术文档撰写者配对,以改进项目文档。

¥Electron is proud to be participating in the second edition of Google's Season of Docs initiative, which pairs mentors from open source organizations with technical writers to improve project documentation.


什么是 Season of Docs?

¥What is Season of Docs?

Season of Docs logo

Season of Docs 是一个促进技术作家和开源社区之间合作的项目,使双方受益。开源维护者利用作者的技术写作专业知识来改进其文档的结构和内容,而技术作者则在导师的指导下加入开源社区。在 Google 的 Season of Docs 网站 上了解更多信息。

¥Season of Docs is a program that fosters collaboration between technical writers and open source communities to the benefit of both parties. Open source maintainers utilize the writer's technical writing expertise to improve the structure and content of their documentation, while the technical writer is introduced to an open-source community under the guidance of its mentors. Learn more about it on the Google's Season of Docs website.

这是我们首次参与该计划,我们将指导一位技术作家,他将与 Electron 的 生态系统工作组 合作,重塑我们文档的大部分内容。你可以了解更多关于整个项目 此处 的时间线的信息。

¥For our first time participating in the program, we'll be mentoring a single technical writer who will be working alongside Electron's Ecosystem Working Group to reshape large parts of our documentation. You can learn more about the timeline of the whole project here.

如何注册?

¥How do I sign up?

你有兴趣作为技术文档撰写者与我们合作吗?首先,熟悉一下 Google 今年的 技术作家指南 项目,并查看我们准备的两个 项目构想草案

¥Are you interested in collaborating with us as a technical writer? First, get familiar with Google's tech writer guide for this year's program, and check out the two project idea drafts that we have prepared.

想要被选为 Electron 文档季的技术作家,候选人需要在 6 月 8 日至 7 月 9 日的技术作家申请阶段,在 Google 文档季网站上提交申请。

¥In order to be selected as Electron's technical writer for Season of Docs, candidates will need to apply on the Google Season of Docs website during the Technical Writer Application phase that is running from June 8 to July 9..

你的申请应包含一份提案,该提案是一份书面文件,详细描述你计划在 3 个月内在 Electron 文档中实现的目标。此提案可以基于我们项目构想文档中提到的起点之一进行开发,也可以是全新的。不知道从哪里开始?你可以查看去年的 已接受提案列表 以获取灵感。

¥Your application should include a proposal, which is a written document that describes in detail what you plan to achieve on the Electron docs over the course of 3 months. This proposal can either develop on one of the starting points mentioned in our Project Idea doc, or can be something entirely new. Don't know where to start? You can check out last year's list of accepted proposals for inspiration.

除了提案之外,我们还会考察你作为技术作家的背景。请附上你的简历副本,重点介绍相关的写作经验,以及技术写作示例(这些示例可以是现有的文档、教程、博客文章等)。

¥Aside from the proposal, we'll also be looking at your background as a technical writer. Please include a copy of your resume with an emphasis on relevant writing experience, as well as technical writing samples (these samples could be existing documentation, tutorial, blog posts, etc.)

如果你想讨论项目提案,请发送电子邮件至 season-of-docs@electronjs.org,我们可以在那里聊天!

¥If you want to discuss project proposals, shoot us an email at season-of-docs@electronjs.org and we can chat from there!

参考

¥References