面向知识工作文档的写作与审稿标准
方案、报告、评审意见、决策备忘、README 与技术文档,先要说清问题、判断、依据和边界;再处理结构、句子和词语。本仓库把这套检查整理为可维护的标准、判例和工具。
维护状态、适用范围、反馈方式与公开边界见 STATUS.md。
本仓库优先采用可回溯的原典、经典写作著作、作者原文、权威机构发布的规范,以及在正式出版物或权威媒体署名发表的文章。中文材料见 来源索引。
材料帮助识别问题,不能替作者承担事实核验或专业判断。仓库规则由材料与脱敏判例共同校验;引文、转述和本仓规则分别标明,不把任何单一作者的意见扩写成普遍法则。
适用于中英文知识工作文档的起草、修改与署前复查。它不代替事实核验、领域审稿、法律或合规审查,也不代替作者的署名责任。
- 可维护的评审标准、原则说明和过程短注
- 已虚构或脱敏的修改判例
- 来源说明、必要短摘和转述
- 可安装的审稿技能与校验脚本
不收录可识别的客户、雇主、项目材料、未脱敏改稿或未发表台账。本地草稿放在 inbox/;该目录不进入版本库。
套话、翻译腔和空泛连接只是表达层的问题。本仓库还检查判断、推理、来源、声称强度、取舍与场合;必要术语、条件、数字和责任主体不能为了“去腔”而删去。
| 路径 | 内容 |
|---|---|
| STANDARD.md | 署前复查的总标准 |
| principles/ | 八个检查维度:定义、问句、常见问题与改法 |
| notes/ | 写前、结构、论证、修改和读者的短注 |
| cases/ | 虚构或脱敏的改稿判例 |
| traditions/ | 来源说明与写作参照 |
| skills/ | 署前复查、信号检测、模拟读者与案例入库技能 |
| scripts/ | 判例校验与启发式扫描脚本 |
- 先读 STANDARD.md,确定文稿用途、读者与风险。
- 关键文稿先做否决快扫,再按八个维度复查。
- 需要局部检查时,选用 技能;需要沉淀经验时,先在本地脱敏,再按 维护说明 入库。
- 运行本地检查:
python -m unittest discover -s tests -v
python scripts/check_cases.py
python scripts/case_coverage.py| 项目 | 当前值 |
|---|---|
| 版本 | 0.8.1 |
| 判例 | 11 篇 |
| 来源与写作参照 | 19 篇 |
| 技能 | 4 个 |
| 最近修订 | 2026-07-29:补充中文来源索引,并统一审校公开中文 |
修订记录见 CHANGELOG.md,收录与维护规则见 MAINTENANCE.md。
代码与脚本采用 MIT License。标准、原则、案例、短注与来源说明采用 CC BY 4.0。英文摘要见 README.en.md。