Files
HEROLL/HEROLL_OUTGAME_DEV_v1.0/文档规范与阅读说明.md
T

29 lines
2.0 KiB
Markdown

# 局外原作开发文档编写规范
## 1. 采用的文档结构
参考局内v0.2.8“玩法总纲 → 分模块规则 → 权威CSV → 规则状态与误写项”的顺序。正文先回答玩家做什么、进度如何变化,再给公式、数值和配置关系。不能用字段目录代替玩法说明。
每个模块的《设计与规则》包含:功能定位、主要状态、逐项规则、操作流程、关键数值、中文内容、开发权威表、验收样例和待补充边界。Markdown和CSV放在同一模块文件夹。
## 2. 规则状态
| 状态 | 处理方式 |
| --- | --- |
| 原作配置确认 | 字段、数组、类型和原注释直接支持的值,按原值使用 |
| 原作文本确认 | 原作中文名称、效果或条件文本;占位符未映射时保留,不当作执行公式 |
| 原作部分确认 | 功能主体或配置关系明确,仍有执行顺序或参数含义缺口 |
| 条件推导 | 写明公式与前提,只用于检查,不充当确认的完整运行规则 |
| 开发映射 | 为理解和实现而拆分的概念状态,不宣称是原作字段名或存档格式 |
| 未知 | 写出具体缺口,不填写新的设计默认值 |
状态对应证据精度,而非功能是否收录。原作配置、原作文本和条件推导分列;文字与数值不一致时保留两者并标明,不能无依据覆盖。
## 3. 使用约定
- 原作版本为HEROLL 2.0.1。只借用v0.2.8文档组织方法,不借用其题材包装、裁剪清单或默认数值。
- 中文名称使用原作本地化文本,保留原字符。没有中文文本时显示StringId,不创造名称。
- 正文列出的操作流程是功能阅读顺序;精确扣除和结算时序未确认的地方不冻结成新玩法。
- 执行规则表、配置表和中文对照表职责分开。中文对照列仅帮助读懂数据,不改写原字段。
- 详细数值以同模块CSV为权威;正文大表注明节选范围。状态和待确认项写入规则表,不靠口头补充。