软件工程
构建仓库架构图谱
分层的仓库地图,连接入口、模块、数据存储、外部系统和所有权,使工程师能够分析变更影响,而不假装图谱已经完整。
流程
按这个顺序做。
- 设定仓库修订、语言、图谱目的、预期细节层级,以及图谱必须帮助回答的问题。
- 盘点入口、构建与部署文件、包、服务、数据存储、队列、外部集成,以及生成或 vendored 区域。
- 使用可用的源代码和仓库证据追踪导入、调用、事件、配置和数据流,记录准确路径与置信度。
- 将节点和关系整理为有用的系统、容器、组件和代码层,不要把不同职责塞进一个框。
- 加入负责人、测试、文档、运行时依赖和外部系统标签,并明确标记推断、过时或不可用的关系。
- 用代表性旅程、构建和测试验证图谱,记录漂移、缺失的边和每项修正的下一位负责人。
- 发布带版本的图谱或图示,包含图例、证据链接、更新触发条件、覆盖限制和未解决风险,而不是无保留地声称完整。
先准备
猫会向你要的输入。
- 仓库与修订
- 架构问题与范围
- 可用的代码与历史访问
- 期望受众与更新负责人
路由器 + 一份 playbook
先路由。只选一份。
Cat Paw 每次任务只加载一份 playbook,不合并多份。先走这个路由器;其余路径是此 workflow 可检查的候选。
- 路由器:
code-graph-pack skills/code-graph-pack/repository-architecture-graph/SKILL.md
界限
界限跟着提示一起走。
- 开始前核实实际工具、账号、权限和工作区;绝不声称拥有不可用的工具、账号、来源或能力。
- 私有代码、产物、实时探测或非公开数据使用 Latch/target-workspace;如果无法访问,就在边界停止并报告阻塞,不要用猜测替代。
- 任何有后果的外部行动前先暂停并取得明确批准;返回证据、未解决风险、假设以及仍等待批准的行动。
完成代表
一个可核对的终点。
带版本的仓库架构图谱将已验证组件和流程连接到源代码证据、负责人、测试、置信度、覆盖限制和未解决风险。
来源
这个流程从哪来。
- github.com/Graphify-Labs/graphify/tree/4c735618f3d56fd622c2049771584621c31ba9ff/
- c4model.com/
- docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners
来源确立 workflow 的模式。如有 Reddit 或社区帖子,视为实务轶事,不是普遍事实。