本页面包含“Google 文档季”接受的技术写作项目的详细信息。
项目摘要
- 开源组织：
- HPX
- 技术文档工程师：
- rstobaugh
- 项目名称：
- 修改并简化现有 HPX 文档
- 项目时长：
- 标准时长（3 个月）
Project description
我的建议是修改现有 HPX 文档的内容，并对其进行简化。我的方案是针对标准期限（三个月）的项目，主要用于修改 STE||AR 小组手册的两章：“HPX Build System and Launching”(1) 和“配置 HPX 应用”(2)。
《HPX Build System and Launching》一章存在几个语法错误，还包含令人困惑的语言，以及“CMake”等术语的大小写不一致。此外，该章节包含重复的信息，我打算根据需要对这些信息进行重新排列、整合和剪辑。虽然“配置 HPX 应用”一章也包含一些需要解决的语法错误，但我主要关注本章内容的用户友好性。本章有三个主要的设计问题，我打算解决：
有些标题被淹没在文本中，使读者难以浏览整章内容。 目前，用户需要仔细阅读手册内容，以了解每个表格的用途。这并不是大多数用户与说明手册互动的方式，尤其是以前已经阅读过内容的用户。我打算确保每个表格都有一个清晰、独特的标题，以便用户滚动浏览文本时可以轻松看到该标题。
列出特定标题下的各种属性时，这些属性未遵循逻辑顺序。 虽然属性会在共同主题下归为一组，而没有子分组，这会让人感觉信息比较分散。例如，用户可能会遇到一些涉及市行政区的属性，其中一些属性涉及另一个主题，另一个属性涉及市行政区。由于标题下没有内部结构，因此很难找到有关特定子主题的所有信息。因此，我计划重新整理多个图表，以便更清晰地将类似信息归到各个标题下。
用户必须来回切换各个部分（或在两个单独的标签页中打开手册），以便充分理解某些说明。 在有些情况下，章节会引导用户前往上一章节中的某一句，这就会迫使读者向上滚动或直接点击某个超链接以了解具体说明，因为本手册在上一章节中使用了模糊的语言，例如“此步骤是在第 11 步之后制定的”。虽然这种方法确实可以消除重复，但会增加理解说明的难度，因为这些任务需要按特定顺序完成。相反，我建议加入更具体的措辞，这样用户就不必在各部分或文档之间切换，从而中断阅读过程。
如果我在标准时间表完成之前完成这些部分，我还想清理 STE||AR 小组的用户文档下的“为什么选择 HPX？” (3) 页面。本页面包含重复的介绍性内容，我希望加以整合，并在大小写（尤其是行话）和语气方面出现不一致，给人一种不一致的感觉。我的目标是为 STE||AR 小组的工作做一个更加统一、一致的介绍。