Communitygithub.com

unkos-dev/specful

Rust CLI,用于便携式、面向AI代理的规格说明、设计记录和决策,基于开放知识格式构建。

specful 是什么?

Specful 是一个 Rust 编写的命令行工具,帮助开发者创建、管理和验证架构决策记录(ADR),特别优化了与 AI 代理(如 Claude Code、Cursor 等)的协作。它基于开放知识格式,确保决策记录的便携性和可验证性,适用于 Git 工作流。该工具支持 `docs/adr/` 目录下的自动编号、占位符填充、索引生成和验证。Specful 强调决策记录的质量:必须包含可信的替代方案和负面后果,避免成为广告或任务清单。生命周期由维护者控制(提议/接受/拒绝/替代),并可通过 `specful-review` 在需要实质性审查的仓库中使用。支持平台包括任何与 Rust 兼容的环境。

兼容平台~Claude Code~Codex CLI~Cursor
npx skills add unkos-dev/specful

在你喜欢的 AI 中提问

打开一个已预加载此 Agent Skill 的新对话。

文档

记录 Specful ADR

ADR(架构决策记录)记录了一个持久决策背后的原因:驱动力、可信的替代方案以及后果。它既不是需求(软件必须做什么),也不是设计(系统如何运作);如果变更涉及“做什么”或“如何做”,请使用 specful-requirement 或 specful-design。保持决策级别:不包含任务序列、文件清单或进度笔记。

工作流

  1. 阅读 docs/adr/ 及其索引,了解编号、状态和已有记录;一条与已有记录相矛盾的新 ADR 应替代它,而不是默默反对。
  2. 使用 specful new adr --title <TITLE> 创建新记录。切勿手动分配标识符;命令负责管理计数器。
  3. 完成占位符。以现在时陈述决策;如实呈现可信的替代方案,而不是为偏好答案设置稻草人;记录负面后果时与正面后果同等重视。没有可信替代方案或没有缺点的 ADR 是广告,而非决策记录。
  4. 生命周期由维护者管理:新记录默认为“提议”状态,只有维护者才能“接受”、“拒绝”或“替代”。
  5. 运行 specful index,然后 specful validate;将重新生成的视图与变更一起提交。当采用仓库需要实质性审查或用户要求时,使用 specful-review。

有关完整的 ADR 配置文件和逐字段指导,请参阅 https://unkos-dev.github.io/specful/。

相关技能