第31课：文档规范与标准
Learning Objectives
- 掌握模板文档（Template Document） 的创建方法及其在项目中的核心作用
- 理解风格指南（Style Guide） 如何统一文档的写作风格与精神
- 应用命名标准化（Naming Standardization） 提升文档空间的可识别性
- 学习在现有文档空间中进行整理和嵌入的最佳实践
- 掌握以读者为中心的文档写作原则及Callout（标注） 的使用技巧
Core Idea
文档规范是整个文档项目的基石。一致性可能是每个文档项目中最重要的方面之一——一本书、一篇论文、一份文件和一个GDD，都需要在格式和结构上保持一致性。
规范体系包含三个层次：
- Template Document（模板文档）：所有其他文档的母体，规定了项目中文档的创建方式和格式标准。模板文档应包含目标说明、受影响文档列表、标题和正文的格式规范
- Style Guide（风格指南）：规范文档的写作方式。如果模板文档规定了”文档如何创建和格式化”，风格指南则规定”文档如何写作”。标准化需要时间，但从长远来看能够赢得效率
- Naming Standardization（命名标准化）：在文档开头添加项目标签（如GDD）、ID编号等，确保文档空间中的每个文件都能被快速识别其所属项目
Key Insight
始终记住，你不是文档的读者。即使你一个人独立制作游戏，文档依然不是为你写的——它们是为游戏服务的。黄金法则是不断自问：“我怎样才能让这个更易读？“
Worked Example
以读者为中心的写作原则：
- 保持简短：使用短句子，尤其是长文档。这并不意味着尽量少写，而是要尽量简洁、直奔主题
- 组织信息：避免大段文字。如果文档中有两个段落，思考如何让它看起来更好、更容易阅读
- 不要假设读者已知：不要认为读者了解文档中的所有内容，为每条必要的信息添加链接
- 保持写作一致性：不要混用标题格式，格式是你的盟友但要避免使用鲜艳的颜色
Callout（标注） 是一种有效的技巧。类似于戏剧中打破第四面墙的手法，标注直接与读者对话：
- 黄色灯泡标注：提示额外想法可以探索
- 蓝色信息标注：提醒非常重要的信息
- 红色警告标注：发出重要警告
- 咖啡杯标注：在长文档开头告知读者这需要细读
IMPORTANT
如果你加入一个已有文档的团队，第一步是承担起文档的责任。先创建Link Tracker（链接追踪器），收集和分类所有重要链接，然后逐步将内容拆分到独立文档中。这借鉴了质量管理系统中的5S方法：整理、整顿、清扫、标准化、维持。
Practice
Self-check
你刚加入一个正在开发中的项目，发现团队已有的GDD是一份200页的单一文档，内容混杂、没有统一格式，团队成员普遍反映”找不到自己想要的信息”。请列出你按照本课所学规范来整理这份文档的具体步骤。
Reveal answer
按照本课学习的规范体系，可以采取以下步骤：
-
创建模板文档：先制定项目的模板文档，规定标题层级、字体、段落格式、标注类型等统一标准。这是所有后续整理的参照
-
制定风格指南：编写简明的风格指南，规定写作语气（如使用主动语态）、术语用法、句子长度限制等。确保今后新增的文档内容在精神上保持一致
-
建立命名规范：为项目定义统一的命名格式，如”[项目标签]-[文档编号]-[文档名称]“。在每份文档开头添加项目标签和ID
-
创建链接追踪器：建立一个索引文档，收集200页文档中所有重要部分的链接，按功能类别（系统、机制、角色、UI等）进行分类
-
拆分内容：将200页文档按主题拆分成独立的小文档（每个功能或系统一个文档），遵循模板文档的格式重新排版
-
添加Callout：在每个文档中使用统一的标注系统，帮助读者快速定位重要信息、注意点和补充说明
-
持续维护：设定定期审查日期，确保新拆分出的文档保持标准化
Next Step
Continue with the next lesson or complete the review task above before moving on.