docs: add M8 user quick start and migration guide - #181
Merged
Conversation
Owner
Author
🔍 Cross-Review:PR #181 四维交叉审查报告
一、CI 合规 ✅ PASS
二、技术准确性问题(12 项,2 项严重)🔴 严重
🟡 中等
三、文档一致性问题(1 项关键,2 项警告)🔴 关键
🟡 警告
✅ 通过项
四、写作质量与用户体验问题🔴 严重:quick-start 信息过载原版"30 分钟上手"是 97 行,现在膨胀到 386 行,混入了大量进阶内容:
建议:quick-start 应只保留核心流程(安装→建项→黄金三章→日常续写),进阶内容拆到 advanced-setup.md 或 quality-review.md。 🔴 严重:新手概念跳跃
🟡 AI 痕迹明显
🟡 migration-guide 三段式建议优化6 个小节每个都严格遵循"是否需要→如何操作→不操作会怎样",过于模板化。建议:
五、汇总评级
建议处理优先级P0(建议合并前修复):
P1(建议尽快补充): P2(后续迭代): 审查方法:4 个独立 Agent 并行审查(技术准确性 × 文档一致性 × 写作质量 × CI 合规),交叉验证后汇总。 🤖 Generated with Claude Code |
Owner
Author
🔄 Round 2:复审报告(针对 commit
|
| # | 问题 | 状态 | 验证依据 |
|---|---|---|---|
| T1 | 门控表补 >= 4.0 行 |
✅ 已修复 | 表格完整覆盖所有分数段 |
| T2 | 删除虚构 hit/partial/miss |
✅ 已修复 | 实际上 excitement_landing 是 QualityJudge 的正式输出字段(见 quality-judge.md),旧版表述不够准确但非虚构;新版改为"判断爽点有没有真正落地"更恰当 |
| T3 | fanqie "尽量"→"必须" | ✅ 已修复 | "第 1 章主角必须在前 200 字内出现" |
| T4 | excitement_type "通常"→"必须" | ✅ 已修复 | "核心爽点类型必须落在 reversal/face_slap/power_up 之一" |
| T7 | 2.0-2.9 人工审核触发方式 | ✅ 已修复 | 补充了"由你决定局部重写还是整章重写;Skill 入口里表现为流程暂停等待确认" |
P1 问题修复状态
| # | 问题 | 状态 | 验证依据 |
|---|---|---|---|
| C1 | migration-guide 补 F0/F 说明 | ✅ 已修复 | 新增第 7 节,5 个编号步骤覆盖完整流程,与 quick-start 描述一致 |
| C3 | 导言补"建议通读"提示 | ✅ 已修复 | 开头改为"仍然建议把全文通读一遍",并新增迁移优先级速查表 |
| P1-5 | 导言解释"黄金三章" | ✅ 已修复 | 首段即定义"指项目开局的第 1–3 章,用来尽早验证平台门控、题材门控和开篇留存能力" |
中等问题修复状态
| # | 问题 | 状态 |
|---|---|---|
| T5 | tomato 兼容说明 | ✅ 改善,"仍作为兼容别名在系统内部工作" |
| T6 | 试写章最终去向 | ✅ 已补,"归档到 logs/quickstart/" |
| T8 | writing_directives 格式 | ✅ 已补,"最好用 DO / DON'T 对比结构" |
| T9 | 风格自然度 7 子指标 | ✅ 已补,7 指标 + structural_rule_violations 附加项,与 quality-rubric.md 完全对应 |
AI 痕迹改善
| 特征 | 修复前 | 修复后 |
|---|---|---|
| "也就是说" | L176 存在 | ✅ 已消除 |
| "换句话说" | L366 存在 | ✅ 已消除 |
| "先不要慌" 教导式语气 | 存在 | ✅ 改为"先看失败点到底来自…" |
| 排比对称 | 四行 100% 对称 | ✅ 改为三行科学分类,合理 |
新增内容质量
- 迁移优先级速查表:3 个场景划分准确,指向对应章节,实用性强
- 第 7 节 Step F0/F 说明:5 步递进清晰,与 quick-start 无矛盾,非模板化
- 风格子指标说明:每项一行中英混排 + 诊断含义,简洁准确
- 未引入新的技术错误
遗留建议(P2,不阻塞合并)
- quick-start 仍为 394 行(原 97→386→394),长期建议拆分核心流程 vs 进阶配置
- migration-guide 仍使用"是否需要→如何操作→不操作会怎样"三段式,但第 7 节已做差异化表述,整体可接受
结论
所有 P0/P1 问题均已修复,无新增错误,AI 痕迹显著改善。建议批准合并。 🟢
复审方法:3 个独立 Agent 并行验证(P0 逐条对标规范 × P1+新增内容交叉校验 × 写作质量+回归检查)
🤖 Generated with Claude Code
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
docs/user/quick-start.mdaround the M8 workflow from init to daily writingdocs/user/migration-guide.mdcovering all backward-compatible M8 migrationsdocs/user/README.mdTesting
git diff --checkCloses #133