Agent Skills
返回列表
✍️

功能规格说明书撰写指南

内容创作 更新于 2026.08.29

将以下提示词粘贴到你的 AI 对话框中:

请根据 https://skillhub.cn/install/skillhub.md,安装 @user_2015f712/functional-spec-writing。

技能介绍

问题在哪

功能规格说明书(FSD)只定义系统做什么:功能需求、行为规则、接口约定与异常处理,不写实现细节。团队常见问题是需求与设计混写、流程只写 Happy Path、接口缺类型与边界,以及「快速响应」这类无法验收的表述——测试和评审因此反复扯皮。

技能如何帮你写规约

本技能按文档级 → 功能级 → 可测试性组织输出,核心包括:

  • 适用边界:明确 FSD 与架构设计、代码 Review、轻量 README 的分工;场景表区分「行为规约 / API 契约」与「算法、表结构、用户手册」。
  • 通用结构:文档概述、功能清单(F-001 编号与依赖)、功能详述(前置条件、正常/扩展/异常流程、规则与约束、接口表)、非功能需求。
  • 撰写原则:正确性、无歧义、完整性、一致性、可测试性、可追溯性;对照反模式表(实现细节、模糊副词、UI 混入等)改写法。
  • 模板与评审:AUTOSAR/嵌入式与 Web/API 请求响应示例;评审清单 + One-Shot 流程(通读 → 逐项核对 → 结论:通过/有条件通过/不通过 → 按 P0/P1 给修改建议)。

注意边界

纯代码 Review、架构图、需求调研应换用对应技能。规约里若出现线程、内存分配等「怎么做」,应挪到设计文档;读者含测试与 PM 时,异常路径与接口参数(必选/可选、默认值、错误码)不宜省略。

使用场景

  • 汽车嵌入式团队中负责 DCM 等 AUTOSAR 模块,需从空白模板写出含前置条件、异常流程与接口表的功能规约。
  • 收到研发提交的 FSD 初稿,需按评审清单与 One-Shot 流程给出通过/有条件通过/不通过及 P0/P1 修改建议。
  • 新 Web 服务上线前,需定义 REST 接口的请求字段约束、响应结构与错误处理,而不写服务端实现细节。
  • 现有 Word 需求混入了线程、表结构等设计内容,需改写成可测试的功能描述并补齐 Happy Path 之外的异常分支。

适合人员

  • 负责 AUTOSAR CP 诊断或通信模块交付的嵌入式工程师,向测试与 OEM 提交标准 FSD 而非内部设计说明。
  • 接口开发前负责写契约的后端开发,需把用户故事落成带 F-001 编号、接口参数与错误码的功能详述。
  • 参与规约门禁或 OEM 评审的测试工程师,需用可测试性清单对每条需求提出可验证的验收问题。
  • 接手多方邮件与会议纪要的新任系统分析,需把零散描述整理成功能清单、非功能指标与修订历史。