@evolvehq/docflow

基于ADR的文档工作流工具,支持全生命周期管理。

安装使用

复制下面这段提示词发给你的 AI(Claude / Cursor / TRAE / Codex / WorkBuddy 等),它会自动帮你完成安装:

帮我安装这个 AI Skill:@evolvehq/docflow。
它的用途是:基于ADR的文档工作流工具,支持全生命周期管理。
完整的 Skill 内容见:https://321skill.com/skills/evolvehq-docflow/raw/index.md
请读取该页面内容,如果是 SKILL.md 格式直接安装,如果是 README 提炼核心 prompt 后安装。

提示词包含完整的 Skill 内容链接,AI 读取后即可完成安装。你也可以 查看完整内容 确认无误。

使用示例

“请在我们的项目根目录初始化ADR工作流。”,它会执行命令,创建包含目录、模板和规范文件的脚手架。然后你可以说:“基于当前‘用户认证’的讨论,起草一份新的ADR。”,AI会引导你填写决策上下文、方案比较和结论,并将其放入计划队列中。

介绍

该Skill主要解决团队在软件开发过程中,架构决策记录(ADR)分散、管理混乱、难以追溯和审计的问题。它通过将一套标准化的ADR工作流(包括目录结构、计划队列和协作规范)快速注入到任何代码仓库中,帮助团队系统化地记录和管理技术决策。

使用方式非常直接,通过一行命令即可在现有项目中初始化完整的ADR工作流脚手架,包括预定义的目录、模板文件和AGENTS.md协作规范。之后,团队成员可以遵循既定流程,进行ADR的撰写、加入发布队列、审核、最终发布以及后续的汇总与审计。

它非常适合正在进行中大型软件项目开发、特别是采用微服务或多仓库架构的研发团队、技术负责人或架构师,用于建立和维护清晰的技术决策历史。

建议在项目早期或进行重大架构重构前引入此工作流,并确保团队对ADR的价值和编写规范达成共识。注意,它更侧重于流程和规范的自动化植入,而非一个图形化的管理界面。

核心特点

与仅提供ADR模板的工具不同,它将ADR管理与类似代码的“开发工作流”(规划、队列、发布、审计)深度结合,并首创了AGENTS.md规范来统一多仓库场景下的协作方式,实现了从单仓库到多仓库的标准化决策生命周期管理。

注意事项

不适合仅需简单记录、无需严格流程管控或项目规模极小的个人或团队。

常见问题

ADR是什么?

架构决策记录,一种记录重要技术决策及其上下文和结果的文档形式。

AGENTS.md文件有什么用?

定义在多仓库环境中,各个AI Agent或自动化工具如何发现、理解和处理ADR的通用约定。

给 AI 助手的安装指引

如果你的 AI 编程助手(Claude Code、Cursor、TRAE 等)能看到这个页面,把下面这段发给它即可自动完成安装:

请访问 https://321skill.com/skills/evolvehq-docflow/raw/index.md 读取 @evolvehq/docflow 的原始 Skill 定义(Markdown 格式),按其中说明在我的环境里完成安装和配置。