后续书写/修订任务清单(Backlog)¶
本清单用于把下一步写什么、怎么验收结构化;默认以
01-*.md为正文,drafts/为写作底稿(不参与站点导航)。
状态快照(2025-12-23)¶
- 章节标准化完成:第 1–20 章(含第 10 章 3 个子篇)均已补齐:关键流程图(纯文本)、示例(可复制)、复现检查清单、常见陷阱(失败样本 ≥ 3 条,含现象/根因/复现/修复/回归验证)。
- 清单与规范升级:
quality-checklist.md(QCR)与C-checklists.md已完成结构化升级;style-guide.md已明确章节最低构件要求。 - AI 审稿:SOP 已更新,模型与工具不绑定,流程见
ai-editor-sop.md。 - 资料笔记:
docs/materials/ai-assisted-software-product/notes/已建立基础覆盖,并在部分章节提供资料笔记(可选)回链。
已完成(2025-12-23)¶
- [x] 示例标准化:所有章节均包含可直接照抄的示例块(目标/前置条件/步骤/验证/失败判定/回滚齐全)。
- [x] 关键流程可视化:全书关键闭环均已通过纯文本流程图/表格呈现(覆盖输入、分支、失败回退与验证动作)。
- [x] 陷阱结构化:常见陷阱已按“现象 → 根因 → 复现 → 修复 → 回归验证”模板重写。
- [x] 清单体系:上线清单与质量门禁已结构化,可直接作为发布门禁使用。
P0(一致性与基础定义)¶
- 全书前置假设与环境约定:在
index.md或preface.md明确基准环境、工具链版本及make <target>(或等价 task runner)约定;验收:读者开读前能理解本仓库的“范式库”定位,而非“开箱即用工程”。 - 术语表扩充 + 禁用同义词策略:补齐
glossary.md(目标 ≥ 25 个核心词条),增加禁用/优先用法说明;验收:全书不再出现概念混用,且首次出现处有链接。 - 命令命名风格对齐:统一正文示例中的任务命名(如
make <domain>-check),并在C-checklists.md给出主推命名;验收:同类检查跨章不再出现多套命名。 - 把 Prompt Library 抽到附录:将正文里的高频/长 Prompt 汇总到
B-prompts.md,正文仅保留核心片段或链接;验收:正文更紧凑,附录模板可直接复用。
P1(完整性与合规)¶
- 补齐资料笔记覆盖面:将
filtered/top-resources.md的关键条目继续整理进docs/materials/ai-assisted-software-product/notes/;验收:各章末尾的资料笔记(可选)能回链到具体解读。 - 统一合规/成本提示:对涉及数据/API 调用的章节补齐 PII、平台条款与预算提醒;验收:读者能预估成本且不踩红线。
- 章节间交叉引用:为关键概念增加“详见第 X 章”链接;验收:每章至少 2 处有效跨章导航。
P2(长期体验优化)¶
- 一致的代码片段风格:统一语言标注、注释密度及占位符写法(
YOUR_TOKENvs<token>);验收:随机抽查 3 章风格一致。 - 安全与合规边界对照表:汇总全书分散的安全建议到独立表格;验收:可作为独立的安全 checklist 使用。
- 角色导读路径:在总览页补充产品/工程/模型视角的阅读路线图;验收:读者能按目标(上线/提质/降本)快速定位章节。
章节任务模板(复制到 Issue/PR 描述)¶
用于把抽象 backlog 拆成可并行、可验收的小任务。
- 目标章节:
XX-*.md - 本次范围(只选 1–3 项):
- [ ] 提取长 Prompt 到
B-prompts.md并回链 - [ ] 统一命令命名(make targets)与环境假设
- [ ] 补术语链接(首次出现处链
glossary.md) - [ ] 补跨章链接(详见第 X 章)
- [ ] 补齐合规/成本提示
- 自检命令:
python3 tools/check_citations.pymkdocs build --strict