SuperAPI AI 工具集

hld-writer

通用与其它

查看项目

更新于 10-16 07:23

技能介绍

用途:承接 PRD(What & Why)与 API Contract(接口契约),解决架构级 How,产出清晰、完整、可落地的高层技术设计文档(HLD);也用于既有文档的有限增量更新(bounded_change)。

主要能力:支持新功能(有 UI/纯后端)、第三方集成、重构、性能/安全优化等类型;提供需求映射表、技术现状与变更、技术架构、复用盘点、技术选型、API 契约引用、数据设计、错误契约、非功能策略、兼容性、发布策略、埋点监控、关键流程、部署架构等章节;用 Mermaid 绘制架构图与时序图;内嵌 TRACEABILITY-METADATA(profile=hld-profile-v1)。

使用方式:先选工作模式(formal_design 走完整流程;bounded_change 走有限增量)。正式流程含阶段零上下文收集(必读 PRD 与 API Contract、识别可复用资源、执行 Guardrails trigger check、输出上下文收集报告)、需求理解、结构规划(按类型读取 assets 下模板)、内容撰写、强制审查(完整性、决策完整性、边界、契约一致性、可落地、证据、追溯元数据)。校验命令:python3 "$TESTANY_ENG_ROOT/scripts/trace_lint.py" --format json <HLD 路径>;可选 python3 "$TESTANY_ENG_ROOT/scripts/trace_build_rtm.py" --format json <PRD 路径> <HLD 路径>。

适用场景:PRD 与 API Contract 完成后需做系统架构设计、技术选型、制定技术方案时。

限制:不写函数签名、类设计、伪代码、具体参数(TTL、超时、重试)、DDL、字段校验与错误文案等 LLD 内容;接口与跨团队错误码以 API Contract 为唯一事实源,不重新定义;禁止无依据猜测技术现状,缺失证据须澄清;默认跟随用户输入语言,TRACEABILITY-METADATA 字段名、枚举值、ID、comment markers 保持英文。具体收费、价格与平台支持情况暂未提供。