本页面包含 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 可能很复杂，但在计算机上安装却很简单。
快速入门指南应涵盖以下内容：
- 如何在 Windows、Mac 和 Linux 上安装 ScummVM。
如何加载、添加和启动游戏。
安装 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 日
- 敲定所有未完成的道具，并正式启动门户！
- 门户发布后，请与导师协商，从其他来源移除多余信息。