share-doc-pipelinelisted

# 总结文档与对外分享流水线 脱敏前后对照与整条流水线（示例数据）：  ## 这套流程解决什么 把已经做完的项目变成**别人看得懂、自己以后还用得上**的总结材料。真正的难点不在写文案，在两件事： 1. **脱敏不能漏。** 项目材料里到处是单位全称、地名、小区名、水表编号、地图坐标、接口密钥。手工一张张图去涂，一定会漏，而漏一个就等于全部白做。 2. **排版不能崩。** 手工排版的东西改一次文案就要重排一次，而且表格溢出、图片变形这类问题只有渲染出来才看得见。 所以这套流程的设计取向是：**能变成代码的都变成代码，剩下的只保留一件必须靠眼睛的事——看图。** --- ## 一次产出两类东西 | 产出 | 面向谁 | 作用 | |------|--------|------| | N 份总结文档 | 外部读者 | 讲清每个项目「为什么做、怎么做、做成了什么、要注意什么」 | | 本流水线本身 | 自己 | 下次有新项目，照着走一遍就能再产出一套 | --- ## 工作流 ### 第 1 步：先读文档，再读数据 每个项目里都已经有说明文档（README / 项目指引 / 项目笔记）。**先把它们读完再去看原始数据**——文档里有结论、有踩坑记录、有当时为什么这么选，这些都比从数据里反推快得多。 同时留意文档与实现是否已经不一致。一个真实的例子：某项目的说明文档里写的默认密码与代码里的实际值不同，文档写的入口文件名也和实际文件名对不上。**这种不一致本身就是总结里最值得写的一条「注意事项」**——它提醒后来的人「文档会过期，以代码为准」。 ### 第 2 步：先定标题，再写正文 标题定不下来，正文一定会跑题。 **原则：动词前置、去掉修饰、一眼知道是什么。** | 要避免的写法 | 为什么 | |--------------|--------| | `项目V2_最终版_0713` | 带版本号和时间戳，对外没有意义 | | `数据可视化实践` | 只有领域，没有对象，读者不知道具体是什么 | | 标题里出现单位名、地名、人名 | 违反脱敏红线 | 每个标题配一句副标题，一句话说清定位： > **降低产销差专项工作汇报** > 从台账数据到可讲、可打印、可分发的一整套汇报材料 ### 第 3 步：列脱敏范围（红线，不能跳） 打开 `references/anonymization-checklist.md`，逐项过一遍，把这个项目里**所有可识别主体**列出来： - 单位全称、下属机构名 → 「某水务公司」「某供水所」 - 市名、区名、街道名 → 「某地」「某经济开发区」 - 小区 / 村庄 / 企业名 → 「片区A」「片区B」…（按出现顺序编号） - 水表编号 / 用户编号 → 「编号隐去」或直接隐藏整列 - 地图坐标、底图 → 模糊化 - 接口密钥、访问密码 → 一律不写进文档 - 个人隐私（姓名、生日、籍贯、测评结果）→ 这类项目**只讲方法，不讲内容** 写进 `scripts/sanitize_shot.py` 顶部的替换表。 **可以保留的**：经营数据的数值本身（万吨、比率、百分点）、行业标准与阈值、技术方案与实现细节。数值是成果的说服力的来源，也是行业通用量级，不构成识别风险。 ### 第 4 步：出图，然后逐张看图 ```bash python scripts/sanitize_shot.py # 截图（截图