gem5 加入 Season of Docs！

我们很高兴地宣布，gem5 项目将参与今年的 Season of Docs。Season of Docs 是由 Google 运行的一个项目，旨在促进开源项目和技术作家之间的合作。

在这篇博客文章中，我们将概述我们是谁以及我们正在寻找技术作家承担的项目类型。在探索阶段（5 月 11 日至 6 月 8 日），我们将开始与技术作家合作，充实项目想法，目标是让技术作家在今年晚些时候加入我们，承担他们提出的项目。

有关 Season of Docs 的更多一般信息可以在 https://developers.google.com/season-of-docs 找到。

我们是谁？

gem5 是一个开源计算机体系结构模拟器。该工具被许多组织使用，从大学研究实验室到大型工业参与者，如 Google 和 ARM。虽然我们在开发一个工程良好且受欢迎的产品方面取得了成功，但文档一直由技术写作经验很少的软件工程师负责。因此，我们希望指导技术作家改进和扩展我们的文档。

gem5 项目高度协作，因此我们接受来自世界各地许多个人的贡献。作为技术作家，您将加入这个社区，我们希望您会发现这是一次有益的体验。

感兴趣吗？

对于有兴趣申请的人，我们建议首先查看我们的当前文档，特别是我们的 Learning gem5 教程，它应该为读者提供如何设置和运行 gem5 的分步指南。然后，我们希望听到技术作家关于如何最好地改进我们文档的建议。

我们在下面列出了一些项目想法。这些绝不是最终版本。我们期望申请人使用这些作为起点，以便在我们的项目中找到有趣的工作。由于我们希望尽可能充分地利用技术写作专业知识，我们鼓励技术作家提出建议并联系我们。作为导师，我们的职责是为技术作家提供所需的上下文，以将这些想法完善为对 gem5 社区有用的内容。

我们不期望技术作家完全理解 gem5 项目的来龙去脉。事实上，我们希望技术作家利用他们的天真作为优势。我们的文档是由熟悉项目的人编写的。因此，我们相信”全新的视角”在许多方面都会有益。gem5 团队中的新技术作家应该能够识别我们文档中的”痛点”并帮助我们改进它们。

项目想法：审核当前文档

我们的文档是在很长一段时间内由不同的人、以不同的目标开发的。因此，我们对 gem5 的哪些领域有充分的文档记录，哪些没有，没有很好的理解。对我们当前文档的审核，以及需要进一步行动的内容，将对社区大有裨益。然后，我们可以制定一个计划，说明如何改进我们的文档。

项目想法：初学者指南文档

目前，我们的 Learning gem5 教程文档是初学者使用 gem5 的”入口点”。我们不确定此文档是否足够，是否应该扩展，或者是否应该用更简洁的内容替换。在这项任务中，我们正在寻找能够改进我们如何向人们介绍 gem5 项目的文档。

与此相关的是，我们的项目经常有新贡献者，其中许多人需要学习如何遵循我们的贡献程序。通常，我们将准贡献者引导到我们的贡献指南和我们的 CONTRIBUTING.md 文档。与我们的 Learning gem5 文档一样，我们希望如果需要的话，对此进行调查和改进。

项目想法：改进源代码文档

我们目前通过 Doxygen 记录我们的代码库。与我们文档的其他领域一样，我们的 Doxygen 文档 是由许多人在多年中开发的，因此其中许多内容以不一致的方式编写。此外，代码库的许多领域完全没有文档记录。这个项目将部分是对我们现有内容的审核，然后制定改进计划。我们也不反对技术作家开始实施这个计划。

gem5 的源代码可以在 https://gem5.googlesource.com/public/gem5/ 找到。

项目想法：改进文档网站

目前，我们的文档 是在 Markdown/Jekyll 网站中创建的。我们遇到了一些限制。特别是，它不容易导航。具有一些 web-dev/Jekyll 经验的技术作家在提出展示我们文档的替代方法（新布局、新样式等）方面将非常有用。

我们网站的源代码可以在 https://gem5.googlesource.com/public/gem5-website/ 找到。

导师

在 gem5 内工作的技术作家将由 Dr. Bobby R. Bruce 和 Prof. Jason Lowe-Power 指导，他们都位于加利福尼亚大学戴维斯分校。请注意加利福尼亚时区（假设标准工作时间为上午 9 点至下午 5 点）以及这对您的影响。我们愿意接受来自世界任何地方的申请人。工作不需要在加利福尼亚工作时间进行，但虚拟会议将定期举行。

如果有兴趣在 gem5 上工作，请在 Season of Docs 探索阶段（5 月 11 日至 6 月 8 日）通过 “bbruce -at- ucdavis.edu” 联系 Bruce 博士。Bruce 博士可以帮助您在提交正式申请之前充实您的想法。有关 Season of Docs 申请流程的更多信息可以在 Season of Docs 网站上找到。