Repository navigation
Releases: F-86/scribe
Releases · F-86/scribe
Release list
v0.11.0 — Multi-file 设计笔记能力(项目设计学习笔记)
🎉 Multi-file 设计笔记能力
新增 项目设计学习笔记 形态 —— 当项目源码 ≥ 5000 行、主题 ≥ 5、需要按主题族分组管理时,把单个设计文档拆成"根 README + 编号主题文件夹 + 编号子文档"的结构。
新增 references/design-doc-multi-file.md,包含:
- 编号方案(00-overview / 10-19 运行时 / 20-29 能力 / 30-39 钩子+deep dive / 40-49 持久化 / 50-59 配置 / 60-69 安全 / 70-79 可观测 / 80-89 跨切面 / 90-99 重建)
- 单文档模板(强制
file:line代码锚点) - 根 README 模板(必含一句话总结 / 怎么读 / incident anchor 表 / 不覆盖什么 / 编辑约定)
- 与 Harness 6 框架(Phase 0-6)的集成要点
配套改动
references/design-doc.md新增"形态选择"章节(单文件 vs Multi-file 边界)SKILL.md文档类型识别表新增 "Multi-file 设计笔记" 行;description 关键词补全CHANGELOG.mdv0.11.0 条目
与现有能力的关系
- 正交于
project-setup.md:前者管深度(一个文档类型怎么拆),后者管广度(项目该有哪几类文档),可组合使用 - 补充
design-doc.md:单文件 vs 多文件的判断流程见design-doc.md顶部
Full Changelog: v0.10.0...v0.11.0
v0.10.0 — Harness 框架重构
v0.10.0 — Harness 框架重构
Added
- 新增
references/harness.md:Harness 6 概念设计框架 - 新增
references/review-checklist.md:Plan / Draft / Final 三阶段分层质检清单
Changed
- 核心流程重构为 6 Phase 线性管道:Intake → Context → Plan → Draft → Review → Revise → Deliver
- 引入 3 个 Checkpoint 检查点:用户在每个关键节点逐项确认
- 引入文件系统状态管理:
.scribe/plan.md、.scribe/draft.md、.scribe/review.md - 渐进加载策略:每阶段指明必读 vs 按需查
- 显式边界段:先判断是否进 Skill 再执行
- 最小切片修复原则:禁止整篇重写
v0.9.0 — 新增测试文档撰写能力
概要
补上开发周期里高频但尚未覆盖的测试文档类型,文档类型从 13 类增至 14 类。
✨ Added
-
新增 测试文档撰写能力(
references/test-doc.md):一份指南统管三种形态——- 测试用例规格(逐条用例:前置 → 步骤 → 预期)
- 测试策略 / 计划(分层、覆盖率目标、范围、CI)
- 测试编写指南(放哪、命名、断言/mock、跑测试)
仿
faq.md的多形态结构,并接入完整同步清单(SKILL.md、modify-doc、doc-map、README、AGENTS.md、trigger-examples、L1 关键词)。 -
doc-map 补两条边界澄清:测试文档 vs CONTRIBUTING、测试策略 vs 设计文档。
🔧 Changed
- 测试文档取向定为默认独立成文(
TEST_PLAN.md/TESTING.md/test-cases/):有对应读者就给独立文件;仅极小项目才并入 CONTRIBUTING 的「测试」一节。
🐛 Fixed
- 修复
doc-map.md中测试相关两条边界行各重复一遍的问题(接入时的意外,已去重)。
完整变更见 CHANGELOG.md。
v0.8.0 — 项目级文档编排 + 自审优化
概要
本版从「逐份写文档」升级到项目级编排,并通过 10 轮自审迭代与端到端实测打磨流程质量。
✨ Added
- 新增 项目级文档编排能力(
references/project-setup.md):支持「项目初始化」与「文档补齐」两个场景,共用统一流程(定项目类型 → 扫描根目录现状 → 算推荐集与缺口 → 列清单交用户确认 → 逐个生成);推荐集采用「通用基础集 + 类型附加项」模型;不自作主张全建,由用户勾选。 - SKILL.md 工作模式从「新建 / 修改」扩展为三种,新增「项目级编排」。
- 新增 提交信息规范撰写能力(
references/commit-message.md,Conventional Commits 格式、类型表、好/坏示例、与 CHANGELOG 的边界)。 - 为 scribe 自身新增
docs/COMMIT_CONVENTION.md。
🔧 Changed(质量打磨,节选)
- 端到端实测堵住 4 个流程盲点:覆盖现有文档防护(新建前做存在性检查)、封装型文档先给选项再扫描、信号歧义去重、多文档生成顺序。
- 新增「多能力 Skill 的 L2 膨胀」设计规则(索引表 >20 行降级为 L3 索引)。
- 更新 L1 description 补全新能力关键词,修复召回率问题。
- 结构精简:合并 SKILL.md 两张表、删孤儿文件
skill-md.md、L2 减重(209→195 行)。
完整变更见 CHANGELOG.md。