SuperAPI AI 工具集

mcaf-adr-writing

写作与研究

查看项目

更新于 10-16 06:45

技能介绍

用途:在 docs/ADR/ 目录下创建或更新 ADR,记录架构决策、依赖变更、数据模型变更或跨领域政策调整。触发条件包括依赖、边界、平台、契约或数据模型发生变化,设计决策存在需要记录的权衡,或仓库级工程政策需要持久化理由。

主要能力:产出具体项目增量(代码、文档、配置、测试、CI 或评审产物);通过显式规划、验证和最终校验减少歧义;留下可复用的项目上下文。

使用方式:先阅读最近的 AGENTS.md 确认范围与约束;从当前必须做出的具体决策出发;若 ADR 缺失,按 references/adr-template.md 搭建;记录背景与问题、所选决策、考虑过的备选方案、权衡与后果、实施计划;仅在能消除歧义时添加图表;将 ADR 链接到受影响的功能文档和 docs/Architecture/Overview.md。交付物为 docs/ADR/ADR-XXXX-short-title.md,以及决策改变边界时对架构文档的关联更新。

验证要点:决策与被拒备选方案明确;权衡具体而非空泛;实施影响清晰;未来工程师能理解为何选择该路径。

限制:不适用于没有架构决策的功能级行为细节,也不适用于通用架构概览内容。输入包括 docs/Architecture/Overview.md、相关功能文档、最近的 AGENTS.md 以及当前约束、选项和风险。其他细节暂未提供。