SuperAPI AI 工具集

lov-architecture-documentation

写作与研究

查看项目

更新于 10-16 00:01

技能介绍

用途:从项目实际实现生成架构视图、接口说明与决策记录(ADR)草稿,适用于需要基于代码库创建架构文档的场景。触发条件为“从项目实际实现生成架构视图、接口说明与决策记录草稿”或“Create architecture documentation from a codebase”。仅查询本技能说明或与上述结果无关的任务不触发;用户仅要预览或审查时不进入修改、提交或发布分支。

主要能力:读取入口、manifest、服务与部署配置、API、数据 schema 及已有 docs;按需选择 C4、arc42、ADR、Mermaid/PlantUML 或完整文档集,文档深度服从项目复杂度;记录系统边界、外部角色、容器/服务、组件职责与数据流,并标注实际证据路径;描述鉴权与信任边界、质量属性、运行部署、观测与恢复事实;ADR 仅在存在历史依据时写已决策记录,推测动机标为待确认;生成可编辑文档与图,检查链接、语法及图与代码一致性。

使用方式:自然语言请求即可触发,无需旧 slash 路径、参数插值或指定助手。需明确解析当前请求中的项目、目标文件、选项与输出位置,使用当前宿主实际提供的文件、搜索、CLI 和浏览器能力。项目依赖版本与外部 API 在执行时核实,不能假设示例为现行配置。随包脚本从 Skill 根解析,业务文件从目标项目根解析。先读当前状态,保护已有未提交内容与其他任务的暂存区。分析、预览请求保持只读;修改、提交、推送、部署和发布各依当前请求的明确范围执行。执行前读取能力组合,按明确制品交接相邻能力;运行前读取本包 skill.yaml 与 Profile 合同,优先级为当前请求、项目上下文、本 Skill records、共享 preferences、brand/user Profile、安全默认值。配置缺失只问影响结果的一个问题;用户明确要求长期保存的值通过 scripts/profile_store.py 原子写入并报告实际路径。

限制:不绕过保护、不自动发送消息、不强制结束用户进程或抢前台;失败保留可诊断原始错误。CI 文档发布只在请求覆盖时配置或执行。不编造作者经历、事实或来源。未实现设计单独标作建议,不把规划能力写成已上线。