本页面包含“Google 文档季”接受的技术写作项目的详细信息。
项目摘要
- 开源组织：
- ScummVM
- 技术文档工程师：
- Cadi
- 项目名称：
- 启动文档门户
- 项目时长：
- 标准时长（3 个月）
Project description
目标：
- 整合来自不同来源的大量信息并重写信息，以确保清晰、一致性和完整性，从而生成高质量、版本化的最终用户文档。
- 文档应该对初学者来说易于理解，而不是精通技术的用户光顾。
- 使用静态网站生成器创建文档门户。
- 创建模板和详细的操作说明，为未来的开源贡献者提供面向未来的最终用户文档。
当前情况：
- 提供的 ScummVM 文档涉及多个来源。
- 信息很难找到，而且经常有重复；很容易被模糊不清的书页迷惑。
- 哪些信息是最新的，哪些信息是过时的，人们很难分清。
- 部分信息缺失或不完整。
解决问题：
建议的文档结构：
着陆页
|-- 使用入门
| -- Quick start guide
|-- Installing ScummVM
| |-- Nintendo 3DS
| |-- AmigaOS
| |-- Android
| |-- (every)
| |-- (common)
| |-- (supported)
|--（平台）
|-- 使用 ScummVM
| |-- 启动器
| |-- 全局设置
| |-- 游戏设置
| -- Keyboard shortcuts
|-- Advanced options
| |-- Cloud and LAN
| |-- Control Mapping
| |-- Configuration
| |-- Command line options
| |-- Graphics
|-- 音乐和声音
|-- 帮助
| |-- 常见问题解答
| |-- 通讯录
|-- 已知问题
| -- Reporting a bug
|-- Game Notes-- 版本说明
- 使用入门：
新用户通常会查找快速入门指南，以便尽快上手。虽然在某些平台上安装 ScummVM 可能比较复杂，但安装到计算机上却并非易事。
快速入门指南应涵盖以下内容：
- 如何将 ScummVM 安装到 Windows、Mac 和 Linux 上。
如何加载、添加和启动游戏。
安装 ScummVM：
如果安装不直观，或者用户可能没有强大的技术基础，则需要用户获得一份全面的指南，才能在任何受支持的平台上安装 ScummVM。
每个综合安装页面都应包含以下内容：
- 任何系统要求/前提条件。
- 如何下载合适的 ScummVM 版本。
- 如何安装 ScummVM。
- 如何将游戏加载到选定的平台，尤其是在游戏所针对的平台不是该平台的情况下。
如何启动 ScummVM、添加游戏和启动游戏。
使用 ScummVM：
用户需要相关参考文档，了解如何使用 ScummVM。
参考文档应涵盖以下内容：
- 启动器界面；每个窗口和标签页的外观及其运作方式。
- 有关可用设置（包括全局设置和游戏专用设置）的说明。
键盘快捷键/热键。
高级选项：
高级用户需要更多的技术性信息，以了解如何调整游戏运行方式。
- 游戏说明：
用户需要了解的任何游戏专属信息；包括但不限于： - 安装过程中的奇怪之处 - 需要任何其他文件 - 控件异常或不同
- 已知问题：
此部分应包含特定于该版本的任何已知 bug。
- 版本说明：
虽然我们的文档会进行版本编号，但提供“版本说明”部分可能有助于提供最新版本的变化摘要。其中可能包括一些目前不在本文档讨论范围之内的方面，例如新支持的游戏或有关新引擎的信息。
攻击计划：
我提议先为“安装 ScummVM”页面创建一个模板，因为这是从端口维护人员/开发者处获取所需信息的最简单方法（尤其是在此信息极少或不存在的情况下）。我会预填充现有文档中已有的所有信息，然后可以检查这些信息的完整性、准确性和货币价值，也可以根据需要进行添加。
接下来，我会梳理现有文档（自述文件、Wiki 和网站）。在此过程中，我会根据需要重新撰写内容并添加每个部分，然后将所有信息提取到新门户中。我还会记录从哪里提取的信息，以确保传送门上线后，不会出现任何重复情况、冲突或其他异常情况。
在整个过程中，我还会与导师、开发者、端口维护人员和任何其他主题专家联系，找出任何缺失的信息，并尽可能确保每个页面都及时更新和全面。
本着协作的精神并得到导师的批准，我希望 ScummVM 社区在整个写作过程中都可以访问进行中的工作门户，以便获得实时反馈并确保整个过程中没有遗漏任何事情。
我建议使用风格指南（例如 Google 开发者文档样式指南），以确保本工作内容和后续所有文档的一致性。
我会尽可能使用屏幕截图、GIF 和其他视觉辅助元素来加深观看者的理解。
拟定时间表：
社区凝聚 2020 年 8 月 17 日 - 9 月 13 日
继续花时间与导师和更广泛的 ScummVM 社区沟通，调整项目的愿景并最终确定文档结构和内容等细节。
第 1 周 9 月 14 日至 9 月 20 日
- 为针对具体平台的安装页面创建模板。
- 使用任何现有信息预填充模板，并分发给相应的端口维护者/开发者以获取更多信息。
第 2 周 9 月 21 日至 9 月 27 日
- 设置新的文档门户。
第 3 周 9 月 28 日至 10 月 4 日
使用 ScummVM： - 界面 - 全局设置 安装 ScummVM： - 系统会将特定于平台的安装指南作为完成的模板返回给我。
第 4 周 10 月 5 日至 10 月 11 日
使用 ScummVM： - 游戏设置 - 键盘快捷键 安装 ScummVM： - 系统会将特定于平台的安装指南作为完成的模板返回给我
第 5 周 10 月 12 日至 10 月 18 日
高级选项： - 云和 LAN - 控制映射 安装 ScummVM： - 系统会将针对具体平台的安装指南作为完成后的模板返回给我
第 6 周 10 月 19 日至 10 月 25 日
高级选项： - 配置 - 命令行选项 安装 ScummVM： - 系统会将针对具体平台的安装指南作为完成的模板返回给我
第 7 周 10 月 26 日至 11 月 1 日
高级选项： - 图形 - 音频 安装 ScummVM： - 系统会将针对具体平台的安装指南作为完成的模板返回给我
第 8 周 11 月 2 日 - 11 月 8 日
帮助： - 常见问题解答 - 通讯录 - 已知问题
安装 ScummVM： - 系统会将针对具体平台的安装指南作为完成后的模板返回给我
第 9 周 11 月 9 日 - 11 月 15 日
帮助： - 报告 bug - 游戏说明 - 版本说明
安装 ScummVM： - 完成尚未完成的所有平台指南。
第 10 周 11 月 16 日 - 11 月 22 日
- 进行最终编辑、校对和最终确定与门户相关的任何决策，例如边栏导航、主题/CSS 调整等。
- 确保所有链接都按预期运行。
- 检查图片/GIF 能否正确显示。
第 11 周 11 月 23 日 - 11 月 30 日
- 敲定所有未完成的物品，并正式发布门户！
- 在该门户上线后，与导师协商，移除其他来源的冗余信息。