本页面包含“Google 文档季”接受的技术写作项目的详细信息。
项目摘要
- 开源组织：
- LLVM 编译器基础架构
- 技术文档工程师：
- DR87
- 项目名称：
- 重构 LLVM 文档索引和文档样式指南
- 项目时长：
- 标准时长（3 个月）
Project description
此项目包含以下任务：
a.) 重新调整文档索引页面的结构，以提供更加人性化的体验。此任务将综合运用独立研究、SME 访谈和用户反馈，评估当前页面并调整页面结构。可能的选项包括：修改简短说明、重构现有网页和/或通过渐进式信息披露模型添加其他图层（网页）。后者会减少主索引页面上的链接数量，使用户能够更轻松地找到特定信息/指南。例如，索引可能包含指向 LLVM 设计与概览、用户指南、子系统文档以及开发流程文档等单独页面的链接。
b.) 更新了面向开源贡献者的 LLVM Sphinx 样式指南。具体任务包括评估现行指南、通过独立研究和中小企业访谈来发现不足之处，以及根据商定的要求更新指南。更新可能包括重新整理指南的布局、添加新内容，以及插入指向相关页面（例如贡献者指南）的链接。最终目标是让志愿者更容易开始贡献内容。