更名 mdpolish 并补充清洗流水线设计与调研记录
- 仓库由 govdoc-md-cleaner 更名为 mdpolish,更新 README、AGENTS、CLAUDE 及 reference 中的仓库名;冻结的 design 与带日期 scratch 保留旧名 - 冻结 0002:可组合清洗组件与流水线(check/transform、单轮修改加最终复查) - 新增 0003 草稿:第一版可执行核心架构,待评审 - 新增 HTML 表格清洗专题调研(2026-08-21)
This commit is contained in:
+14
-11
@@ -8,14 +8,16 @@
|
||||
|
||||
## 1. 目录与生命周期
|
||||
|
||||
| 内容 | 目录 | 维护方式 |
|
||||
|---|---|---|
|
||||
| 动工前的方案比较、选择和代价 | `design/` | 批准后冻结;改变时新增下一编号 |
|
||||
| 当前有效的机制、数据流和原因 | `explanation/` | 事实变化时同步更新 |
|
||||
| 代码无法完整表达的稳定查询事实 | `reference/` | 权威事实变化时更新 |
|
||||
| 可复现运行、验证与排障步骤 | `guides/` | 操作变化时更新并重新验证 |
|
||||
| 调研笔记、计划和未收敛草稿 | `scratch/` | 不作为当前事实;由项目负责人决定去留 |
|
||||
| 当前阶段和已完成工作 | 根目录 `README.md` | 阶段变化时更新 |
|
||||
|
||||
| 内容 | 目录 | 维护方式 |
|
||||
| --------------- | --------------- | ------------------ |
|
||||
| 动工前的方案比较、选择和代价 | `design/` | 批准后冻结;改变时新增下一编号 |
|
||||
| 当前有效的机制、数据流和原因 | `explanation/` | 事实变化时同步更新 |
|
||||
| 代码无法完整表达的稳定查询事实 | `reference/` | 权威事实变化时更新 |
|
||||
| 可复现运行、验证与排障步骤 | `guides/` | 操作变化时更新并重新验证 |
|
||||
| 调研笔记、计划和未收敛草稿 | `scratch/` | 不作为当前事实;由项目负责人决定去留 |
|
||||
| 当前阶段和已完成工作 | 根目录 `README.md` | 阶段变化时更新 |
|
||||
|
||||
|
||||
根目录 `AGENTS.md` 与 `CLAUDE.md` 是协作者入口,不放入 Wiki。
|
||||
空分类使用 `.gitkeep` 保留,不创建只写未来设想的占位文档。
|
||||
@@ -83,11 +85,12 @@ guide 必须来自实际运行,至少包含前置条件、准确命令、预
|
||||
- 小型汇总进入 Git 前必须确认无法还原客户内容;
|
||||
- 每个实验应能追溯输入范围、版本、参数、环境、指标和输出位置。
|
||||
|
||||
## 9. 写作与审查
|
||||
## 9. 写作与审查(非常重要!!!务必遵守!!!)
|
||||
|
||||
- 面向没有参加过讨论、但具备相关技术背景的读者;
|
||||
- 面向没有参加过讨论、但具备相关技术背景的读者,要用人话讲解!别创造黑话,别堆积信息密度极大的长难句!
|
||||
- 尽量多使用表格和图,让读者更容易看懂。
|
||||
- 从真实问题或读者可见现象开始,不先堆术语;
|
||||
- 结论写清理由、代价、适用边界和验证状态;
|
||||
- 参数、路径、命令、指标和当前阶段只维护一个权威版本;
|
||||
- 不把目标写成已完成,不泄露真实文档内容,不用文档替代测试;
|
||||
- 简单事实用短段落,只有比较关系确实更清楚时才使用表格或图。
|
||||
|
||||
|
||||
Reference in New Issue
Block a user