本页面包含 Google 文档季接受的技术写作项目的详细信息。
项目摘要
- 开源组织：
- HPX
- 技术文档工程师：
- rstobaugh
- 项目名称：
- 修改并简化现有 HPX 文档
- 项目时长：
- 标准时长（3 个月）
Project description
我的建议是修改和简化现有 HPX 文档的内容。我的提案是一个标准学期（三个月）项目，重点是修改 STE||AR 团队手册的两章：“HPX 构建系统和启动”(1) 和“配置 HPX 应用”(2)。
“HPX 构建系统和启动”一章中存在多处语法错误，还包含令人困惑的语言，并且“CMake”等术语的大小写不一致。此外，该章节包含重复的信息，我计划根据需要对其进行重新排列、整合和精简。虽然“配置 HPX 应用”一章也包含一些需要解决的语法错误，但我对本章的主要关注点是易用性。本章包含我计划解决的三大设计问题：
有些标题埋在文本中，因此很难浏览章节。 目前，用户需要仔细阅读手册，才能了解每个表的用途。大多数用户与操作手册的互动方式并非如此，尤其是在他们之前已阅读过相关内容的情况下。不过，我打算确保每个表格都有清晰、独特的标题，这样当用户滚动浏览文本时，就能轻松看到这些标题。
在特定标题下列出各种房源时，房源未遵循逻辑顺序。 虽然房源会按共同主题分组，但没有子分组，因此信息看起来比较零散。例如，用户可能会遇到几个与地区性相关的媒体资源，几个与其他主题相关的媒体资源，然后再遇到一个与地区性相关的媒体资源。由于标题下缺少内部结构，因此更难找到特定子主题的所有信息。因此，我计划重新整理几张图表，以便更清晰地将类似的信息归到每个标题下。
用户必须在各部分之间来回导航（或在两个单独的标签页中打开手册），才能完全了解某些说明。 本章在某些地方会将用户引导至前一节中的某个句子，而该句子使用模糊的语言（例如“此步骤在第 11 步之后执行”），迫使用户向上滚动或点击超链接才能了解确切说明。虽然这种方法确实可以避免重复，但会增加理解说明的难度，因为这些任务需要按特定顺序执行。我建议改用更具体的措辞，以免用户在不同部分或文档之间切换时中断阅读进程。
如果我在标准时间范围结束之前完成这些部分，还想整理 STE||AR 团队用户文档下的“Why HPX?” (3) 页面。此页面包含重复的介绍内容，我希望对其进行整合；此外，此页面中的大小写（尤其是专业术语）和措辞不一致，给人一种不统一的感觉。我的目标是制作一个更统一、更一致的 STE||AR 团队作品简介。