Bepr4
be1a600fdc
- 移除旧清洗器、规则、测试和打包配置 - 增加 AGENTS.md 与 CLAUDE.md 同步协作规范 - 建立 research-wiki 文档生命周期和首个设计记录
68 lines
2.6 KiB
Markdown
68 lines
2.6 KiB
Markdown
# govdoc-md-cleaner
|
|
|
|
政务文档 PDF→Markdown 清洗方向的独立研究与治理仓库。
|
|
|
|
本仓库用于澄清清洗问题、记录设计选择、积累可复核证据，并在方案获得确认后再建立实现。
|
|
它目前不是可安装的 Python 包，也不提供命令行工具或生产接口。
|
|
|
|
## 当前阶段
|
|
|
|
2026-08-20 已完成仓库重置与最小文档治理骨架：
|
|
|
|
- 原有 Python 实现、YAML 规则、测试和打包配置已经移除；
|
|
- `AGENTS.md` 与 `CLAUDE.md` 提供同步的协作规则；
|
|
- `research-wiki/` 按文档生命周期区分设计、说明、参考、指南和草稿；
|
|
- `research-wiki/design/0001-repository-foundation.md` 记录本次基础架构选择。
|
|
|
|
当前没有清洗算法、可执行命令、运行依赖、测试套件或已批准的输入输出契约。
|
|
目录存在只代表文档落点已经建立，不代表相应能力已经完成。
|
|
|
|
## 项目边界
|
|
|
|
- 研究对象是 MinerU、OCR 等 PDF→Markdown 管线产生的噪音与清洗方法；
|
|
- `/home/lihaoze/gov_test_data` 中的真实材料属于外部只读数据，不复制、不修改、不提交；
|
|
- 任何清洗语义、规则格式、评估指标、代码目录或运行依赖，都应先形成设计记录并获得确认；
|
|
- 研究结果只有经过独立评审后，才能进入其他产品或生产仓库。
|
|
|
|
## 目录结构
|
|
|
|
```text
|
|
govdoc-md-cleaner/
|
|
├── AGENTS.md
|
|
├── CLAUDE.md
|
|
├── README.md
|
|
└── research-wiki/
|
|
├── README.md
|
|
├── design/ # 方案选择与冻结决策
|
|
├── explanation/ # 当前有效机制及原因
|
|
├── reference/ # 需要准确查询的稳定事实
|
|
├── guides/ # 已实际验证的操作步骤
|
|
└── scratch/ # 调研笔记和未收敛草稿
|
|
```
|
|
|
|
## 开始工作
|
|
|
|
进入仓库后依次阅读：
|
|
|
|
1. 本文件，确认当前阶段；
|
|
2. `AGENTS.md` 或 `CLAUDE.md`，确认协作与安全边界；
|
|
3. `research-wiki/README.md`，确认文档应放在哪里；
|
|
4. 与任务直接相关的 `research-wiki/design/` 记录。
|
|
|
|
下一项实质工作开始前，应新增下一编号的 design，明确问题、备选方案、输入范围、验收方法和非目标。
|
|
|
|
## 当前可用检查
|
|
|
|
```bash
|
|
# 两份 Agent 入口除标题外必须一致；无输出且退出码为 0 表示通过
|
|
diff -u <(tail -n +2 AGENTS.md) <(tail -n +2 CLAUDE.md)
|
|
|
|
# 查看当前 Wiki 中实际存在的文档
|
|
find research-wiki -maxdepth 2 -type f | sort
|
|
|
|
# 检查本地变更
|
|
git status --short
|
|
```
|
|
|
|
当前没有测试命令；在真实实现和测试体系获批并落地前，不应声明测试通过。
|