报告易读性自检(术层 · 实现/走查报告的内容组织)
术-内容 · 术层 skill 全文
本页是 <code>rules/skills/drafts/bestpractice_report_readability.md</code> 的逐字投影(仅隐私清洗,零改写)。
时点提示:本页是仓内文件 rules/skills/drafts/bestpractice_report_readability.md 的逐字投影(仅做隐私清洗:仓库根绝对路径→相对路径、家目录→~/;除此零改写)。若源文件后续有修订,以仓内真源为准。
报告易读性自检(术层 · 实现/走查报告的内容组织)
元数据
- 类型:BestPractice
- 适用场景:写"记录已完成工作"的报告时(实现说明、走查、迭代记录)做内容层自检。调研 / survey 类报告走另一格的去 AI 化 skill,不走本 skill
- 状态:Draft(2026-05-31,由小白可读版重构为易读性版)
- 道术位置:
COMMUNICATION.md(道)管语言去 AI 味;本 skill(术·内容)管写什么、怎么组织、怎么核对;HTML / MD 渲染(术·格式)归bestpractice_final_report与 markdown 类 skill - 来源:用户 2026-05-27 与 05-31 session 原话(变化记录、回看记录自检、图优先、降噪)+
bestpractice_final_report的无背景卡点机制
先纠正一个误解:易读性不是小白化
易读性不是把内容简化到小白能懂。是清晰完整地记录变化,让读者(用户本人和队友)一遍读懂发生了什么。重要概念可以在不同段落适当重复,方便理解。细节可以专业,但必须记录清楚,不回避、不简化掉真实实现。目标是清晰,不是浅。
报告必须讲清的四件事
一份记录工作的报告,缺一件就不合格:
- 任务怎么做的:给路径,不只给结论。
- 改了哪些:说清改的是什么内容,不是只贴 diff。
- 之前 vs 之后:同一对象改动前后的对比。
- 遇到的问题:完整记录踩的坑和怎么解决的。
贯穿这四件的是一条证据链(用户 05-27 原话):报告要呈现"基于某次运行 / 测试结果 → 做了什么修改 → 怎么满足了需求"。这条链断了,报告就退化成结论堆砌。
变化优先用图表现
人对图像理解更快。"之前 → 之后"的变化优先用图(流程图、架构图、对比图、时间线),不要纯文字描述。核心改动和外围改动分开画,不要一锅烩。
产出前的 look-back 自检(硬要求)
报告不能凭记忆写,先回看真实过程记录再写:
- 有 Loop 记录文件(PROGRESS / HANDOFF / evidence)就读它们
- 没有就用 skill
bestpractice_chat_history_retrieval调本次 session 的聊天记录 - 都没有就从整个完成过程复盘,逐步对照
报告里每个"改了 X"都要能在记录里找到落点。这一步是防止报告凭印象漂移、报喜不报忧的关键,也是用户反复纠正过的点。
不写进正式报告的(降噪)
- 文件存放路径
- Proposal / Project 的原始要求复述
- 自己实现得很差、无价值的版本(不写也不画图),重点放在有效的分析和真实变化
例外分流:landing-pipeline 任务报告必须逐字记录原始 prompt,见 workflow_report_writing_matrix 的"landing-pipeline 任务报告约定"。
易读性卡点验证
派一个无背景 sub-agent 通读初稿,挑它真卡住的地方:A 术语没解释 / B 指代不明 / C 概念不充分 / D 假定背景。口径是清晰记录(读者不卡、能复现你的理解路径),不是小白都懂。prompt 模板复用 skill bestpractice_final_report 附录 1,格式无关,任何草稿都能跑。
验收标准(无背景 agent 也能判定)
- 四件事(怎么做 / 改了什么 / 前后 / 问题)都有,且每条能在过程记录里找到落点
- 关键改动至少有一张图表现 before / after
- 去 AI 味遍扫过(COMMUNICATION.md 四类套路 + 回译测试)
- 噪声(路径 / proposal / 失败实现)没出现在正式报告
- 无背景 sub-agent 通读后真实卡点密度低
边界(不做什么)
- HTML / CSS / MD 渲染:归
bestpractice_final_report与 markdown 类 skill - 调研 / survey 报告的播客式去 AI 化:归 survey 去 AI 内容 skill(DSE 家族,另一格)
- 语言规则本身:归
COMMUNICATION.md,本 skill 只给内容层的查与改
已知陷阱(真实,带出处)
- 作者凭记忆写报告会漂移、报喜不报忧(用户 05-27 / 05-31 多次纠正):必须 look-back 真实记录核对,不能凭印象。
- 作者自挑卡点会漏(
bestpractice_final_reportT6):派零背景 sub-agent,prompt 禁止读其他文件、禁止预训练脑补。
<!-- created 2026-05-31 by zlx: 易读性=完整记录变化(重构自小白可读版),配 COMMUNICATION.md 道层 -->