SuperAPI AI 工具集

architecture-md-writer

通用与其它

查看项目

更新于 10-16 01:26

技能介绍

ARCHITECTURE.md Writer 用于编写架构文档,让贡献者快速建立系统形态、起始位置和不可破坏约束的心智模型。它强调稳定结构而非实现细节,且除非范围不对,优先编辑已有 ARCHITECTURE.md,而非新建。

用途与范围:判断任务是针对仓库根、子系统还是两者;根文档作为系统地图而非百科;仅当子树有足够独立的结构、生命周期或约束时才添加嵌套文档,并在父文档中一行链接并说明其范围。在决定拆分、合并、增删架构文档前,先读 guides/document-topology.md。

主要能力:从稳定代码结构建立上下文,检查入口点、包边界、长期目录、接口、后台任务、存储接缝和外部集成;端到端追踪一两条重要流程;先梳理职责、交互和不变式再写作;只对已有文档恢复边界、术语和决策历史。

使用方式:草拟最小可用文档,说明系统或模块用途、主要部分及交互;用具体文件和目录起始点替代详尽清单;仅在缩短解释时使用小型 ASCII 图,不用 Mermaid;章节名贴合系统而非套固定模板。草拟新文档、重组章节或选择组件、运行时流、代码路径、不变式呈现方式前,先读 guides/section-patterns.md。

审查与限制:确保新工程师能回答主要部分、从哪追踪行为、什么不能破坏;删除普通重构后即失效的表述;更新时逐条核对剩余声明;校验链接、路径和父子文档引用;保留仓库术语。保持高层与持久,省略逐类/逐函数目录、安装步骤、编码规范、运行手册和教程,除非设计约束依赖它们。用 ADR 链接说明理由与权衡;不确定则少写并指向最佳起始文件,不臆测。缺少 ADR 只简要注明,不编造理由。