规则文件与文档同步对照清单（v3.5）
字数
739 字
阅读时间
3 分钟
用途：每次调整规则、静态映射或导出行为后，快速核对代码与文档是否一致。
A. 代码源文件
基础核对范围：
- weapon_rule_ranges.py
- weapon_refinement_rules.py
- attachment_rule_ranges.py
- ammo_rule_ranges.py
- gear_rule_ranges.py
- generator_static_data.py
- generate_realism_patch.py
- audit_output_rule_violations.py
- tests/test_name_extraction.py
- tests/test_gear_rules.py
B. 需要同步的文档
- README.md
- 现实主义数值生成器快速入门.md
- 现实主义数值生成器使用说明.md
- 现实主义数值生成器详细使用说明.md
- 现实主义数值生成器高级配置指南.md
- 武器属性规则指南.md
- 附件属性规则指南.md
- 弹药属性规则指南.md
- 装备属性规则指南.md
- CHANGELOG.md
C. 每次改规则时至少检查的点
C1. 武器
- 一级基础档是否仍与 weapon_rule_ranges.py 一致
- 口径细分与枪托细分是否仍与 weapon_refinement_rules.py 一致
- 文档中是否还留有过期数值，例如 smg 的旧后坐范围
C2. 附件
- 附件档位命名是否与 attachment_rule_ranges.py 一致
- 文档是否说明 ensure_fields=True 的当前行为
- 审计文档是否仍说明 mod_profile_unresolved 的忽略策略
C3. 弹药
- 三层结构说明是否仍与 ammo_rule_ranges.py 一致
- 穿深 11 级分层是否仍被正确描述
- ArmorDamage 与故障概率硬限制是否仍与主流程一致
C4. 静态映射与默认模板
- 若改了 PARENT_ID_TO_TEMPLATE、ITEM_TYPE_NAME_TO_ID、DEFAULT_*_TEMPLATE、MOD_TYPE_SPECIFIC_ATTRS，README 和高级配置指南是否同步
C5. Gear
- gear_rule_ranges.py 的档位命名是否仍与文档一致
- 装备属性规则指南.md 是否仍反映“模板文件主档 + 少量二级细分”的当前结构
- 审计是否仍对 cosmetic 保持豁免，只对防毒/防辐射类饰品做 gear 规则识别
C6. 输出与工作流
- README、快速入门、详细说明是否仍说明“按源文件导出 + CURRENT_PATCH 占比阈值”的当前策略
- 使用说明是否仍包含 GUI 编辑器、自动备份、一键生成补丁和字段说明面板的当前能力
- 审计脚本命令和默认输出路径是否仍正确
- 名称回归测试命令是否仍正确
D. 版本号同步点
每次发版至少同步以下位置：
- generate_realism_patch.py 横幅
- 现实主义数值生成器.bat 横幅
- README.md
- 四份使用文档
- 四份规则指南
- 本清单
- CHANGELOG.md
E. 推荐发版顺序
- 先改代码和规则文件
- 跑小样本生成
- 跑 audit_output_rule_violations.py
- 如涉及 gear 规则，跑 tests.test_gear_rules；如涉及格式兼容或名称提取，跑 tests.test_name_extraction
- 同步所有文档与版本号
- 最后再做全量生成
贡献者
SamuelNOTCuriousMeow