Skip to content

规则文件与文档同步对照清单(v2.0)

字数
649 字
阅读时间
3 分钟

用途:每次调整规则、模板映射、例外物品流程或审计逻辑后,快速确认代码与 docs 是否仍一致。

A. 代码核对范围

基础核对文件:

  • RealismPatchGenerator.Core/RuleSetLoader.cs
  • RealismPatchGenerator.Core/RealismPatchGenerator.cs
  • RealismPatchGenerator.Core/OutputRuleAuditor.cs
  • RealismPatchGenerator.Core/WeaponRuleData.cs
  • RealismPatchGenerator.Core/AttachmentRuleData.cs
  • RealismPatchGenerator.Core/AmmoRuleData.cs
  • RealismPatchGenerator.Core/GearRuleData.cs
  • RealismPatchGenerator.Core/ItemExceptionImportService.cs
  • RealismPatchGenerator.Core/ItemExceptionFieldGuardService.cs
  • RealismPatchGenerator.Gui/Form1.cs
  • RealismPatchGenerator.Gui/ItemExceptionsForm.cs
  • RealismItemRules/weapon_rules.json
  • RealismItemRules/attachment_rules.json
  • RealismItemRules/ammo_rules.json
  • RealismItemRules/gear_rules.json
  • RealismItemRules/item_exceptions.json

B. docs 目录主文档

当前优先维护这些文件:

  • docs/使用说明.md
  • docs/规则说明.md
  • docs/武器属性规则指南.md
  • docs/附件属性规则指南.md
  • docs/弹药属性规则指南.md
  • docs/装备属性规则指南.md

C. 每次改动后至少检查的点

C1. GUI

  • 启动命令是否仍是 dotnet run --project RealismPatchGenerator.Gui
  • 文档是否仍明确说明生成与审计通过 GUI 执行
  • 使用说明中的按钮名称是否与 GUI 当前文案一致

C2. 例外物品

  • 例外窗口是否仍按 Name 只搜索 output 结果
  • “新增/修改字段”与“保存物品”的行为描述是否准确
  • item_exceptions.json 的保存位置和作用范围是否写对

C3. 审计范围

  • consumable 与普通 cosmetic 仍不作为规则审计主范围
  • mod_profile_unresolved 仍不作为附件审计噪音计入结果
  • 例外字段豁免仍是“按字段豁免”而不是“整件物品跳过”

C4. 输出行为

  • 文档是否仍说明 output 不会被整目录清空
  • 文档是否仍说明结果按当前生成目标覆盖写出
  • 文档是否仍明确说明只有 input/attatchments、input/gear、input/weapons 下的 RealismStandardTemplate 输出保持原文件名
  • 文档是否仍明确说明其他支持的输出文件追加 _realism_patch
  • 文档是否仍明确说明输出条目顺序必须与输入源顺序一致
  • 模板一致性说明是否仍覆盖四大类物品格式

C5. 版本号

  • docs 内标题和版本说明都已更新到 v2.0
  • CHANGELOG.md 与 README.md 是否也已同步到同一版本

D. 推荐发版顺序

  1. 修改代码、规则和模板相关逻辑。
  2. 运行 dotnet build RealismPatchGenerator.slnx。
  3. 生成小样本 output 并检查关键文件格式。
  4. 在 GUI 中执行审计并回看 audit_reports。
  5. 同步 docs 与版本号。
  6. 最后再做全量生成与人工回归。

贡献者

The avatar of contributor named as SamuelNOTCuriousMeow SamuelNOTCuriousMeow

文件历史

撰写