SuperAPI AI 工具集

04-interface-specification

编程与开发

查看项目

更新于 10-16 03:40

技能介绍

用途:在软件需求规格说明书(SRS)中把描述性建模转为明确的连接性需求,产出 3.1 节接口规格,涵盖用户、软件、硬件、通信与外部接口;实现级 OpenAPI 契约应交给 api-specification 处理。

主要能力:检测技术栈关键词(如 Ubuntu、OCI、MySQL、HP Z440)并从功能用户故事中提取外部参与者;用 Markdown 表格列出硬件与软件接口,显式列出端口与协议(如 443/TLS 1.3、3306、5432、IEEE 802.11ax、RFC 7519 JWT);描述通信栈连通性映射;以 SHALL 语句书写并引用 ISO/IEC 25010、ISO/IEC 25062、ISO/IEC 25051 等标准。

使用方式:前置第 1.0、2.0 节已生成。输入 projects/<ProjectName>/_context/tech_stack.md、features.md、quality_standards.md;输出 projects/<ProjectName>/<phase>/<document>/SRS_Draft.md(仅 3.1 节),或写入 projects/<ProjectName>/02-requirements-engineering/01-srs/<section-file>.md。可运行 python interface_specification.py,或通过 logic.prompt 由 Claude 按 Manual Execution 直接执行,无需 Python 也可用内联上下文生成。

限制:缺少所需输入、责任人或确定性测试判据时应停止受影响步骤并返回合格的缺口记录,不得编造证据、标准条款、阈值或干系人决策;接口缺少归属、校验、错误、超时或版本行为时阻止批准;不可用的检查须标记为未评估,不得视为通过;发布、生产变更、破坏性操作、付费与认证需明确授权。