工程开发
mcaf-architecture-overview avatar

mcaf-architecture-overview

维护一个包含 Mermaid 图表的集中式架构总览,记录系统边界、模块依赖与接口契约,以利于项目导航与重构。

简介

此技能作为架构文档的主要维护工具,专注于 docs/Architecture/Overview.md 的管理。它提供了一种结构化的机制来定义软件项目的全局架构图,确保系统边界、核心模块与接口契约与实际代码保持同步。通过强制使用 Mermaid 图表,代理程序能建立既易于人类阅读又便于机器导航的系统架构可视化表示。此技能旨在防止「架构漂移」,要求每个图表元素都必须参考真实的组件或文件路径,避免使用预留位置或抽象推测。对于正在进行导入、重大重构或定义复杂系统新边界的团队而言至关重要。它遵循 MCAF(模型-上下文-架构-框架)标准,确保架构决策链接至 ADR 与功能,而不会因行为逻辑或实现细节导致总览杂乱。

  • 根据现有的文件夹结构与命名空间自动生成或更新 docs/Architecture/Overview.md

  • 使用标准化 Mermaid 图表可视化模块边界、依赖方向与核心接口契约。

  • 通过将每个图表元素链接至对应的源代码或文档,为开发人员与代理程序提供「从这里开始」的导航点。

  • 通过执行依赖规则(允许与禁止的调用)并识别横向关注点,维护严格的架构完整性。

  • 通过在 1 分钟内的阅读时间内总结系统职责与高阶交互模式,促进项目导入效率。

  • 代理程序预期现有的文件夹结构能代表领域边界(如 Docs/Architecture/Docs/ADR/)。

  • 在提议更改之前务必验证当前架构状态,以确保不会引入虚构的组件或无意义的内容。

  • 使用此技能来保持文档稳定;仅在结构边界或重大交互模式变更时进行更新。

  • 专注于结构图而非行为流程;将行为特定文档委托给 docs/Features/

  • 确保每张图表保持可读性;如果系统变得过于复杂,请通过边界进行拆分以保持清晰度。

仓库统计

Star 数
18
Fork 数
0
Open Issue 数
0
主要语言
C#
默认分支
main
同步状态
空闲
最近同步时间
2026年5月3日 16:46
在 GitHub 查看