LLVM 编译器基础架构项目

本页面包含 Google 文档季接受的技术写作项目的详细信息。

项目摘要

开源组织：

LLVM 编译器基础架构

技术文档工程师：

DR87

项目名称：

重构 LLVM 文档索引和文档样式指南

项目时长：

标准时长（3 个月）

Project description

此项目包含以下任务：

a.) 重构了文档索引页，以提供更人性化的体验。这项任务涉及评估当前页面，并综合考虑独立研究、SME 访谈和用户反馈来调整页面结构。可能的方案包括修改简短说明、重构现有页面，以及/或者通过渐进式信息披露模型添加其他层（页面）。后者可减少主索引页上的链接数量，以便用户更轻松地找到特定信息/指南。例如，该索引可能包含指向 LLVM 设计和概览、用户指南、子系统文档和开发流程文档的单独页面的链接。

b.) 更新了面向开源贡献者的 LLVM Sphinx 样式指南。这项任务包括评估现行指南，通过独立研究和 SME 访谈找出不足之处，以及根据商定的要求更新指南。更新可能包括重新整理指南的布局、添加新内容，以及插入指南中相关页面（例如贡献者指南）的链接。最终目标是让志愿者更轻松地尽快开始贡献。