LLVM 项目博客

LLVM 项目新闻和来自一线的详细信息

LLVM 和 Google Season of Docs

LLVM 项目很高兴地宣布，我们已入选 Google 的 Season of Docs！

我们的项目创意列表可以在这里找到
https://llvm.net.cn/SeasonOfDocs.html

从现在到 5 月 29 日，我们鼓励技术作家审查提议的项目创意，并通过我们的[email protected]邮件列表提出任何问题。其他文档创意是可以接受的，但我们不能保证会为该项目找到导师。我们鼓励您在提交技术作家申请之前在邮件列表中讨论新的创意，以便开始寻找导师的过程。

在提交 LLVM 文档项目的申请时，请考虑以下几点

  • 包含先前经验：您是否有过技术写作经验？我们希望看到这些！考虑包含先前文档的链接或您撰写的文档的附件。如果您无法包含指向实际文档的链接，请详细描述您所写的内容、目标受众以及任何其他有助于我们评估您先前经验的重要信息。此外，请包含您使用 Sphinx 或其他文档生成工具的任何经验。
  • 花时间撰写提案：我们会仔细查看您的申请，了解其撰写水平。花时间校对并了解您的目标受众。
  • 提出您对我们文档项目的计划：我们已经粗略地介绍了我们对文档的更改或主题的设想，但这仅仅是一个开始。我们希望您能够根据自己的想法进行扩展或修改。审查我们现有的文档，了解它如何补充或替换其他内容。可选地，在您的申请中包含文档设计或布局计划的概述。
  • 熟悉我们的项目： 我们不希望您成为编译器专家，但我们希望您阅读我们的项目以了解一些 LLVM 的知识。

我们期待与一些优秀的技术作家合作，改进我们的文档。再次强调，请通过[email protected]联系我们，提出您的问题。